Move examples to server directory (#198)
* move examples to server directory This will prepare for the client implementation in https://github.com/modelcontextprotocol/php-sdk/pull/192 * fix move bootstrap too
This commit is contained in:
Tobias Nyholm
GitHub
parent
c3244fcdd4
commit
6dac6f3b4a
3 changed files with 56 additions and 56 deletions
152
examples/server/discovery-userprofile/McpElements.php
Normal file
152
examples/server/discovery-userprofile/McpElements.php
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the official PHP MCP SDK.
|
||||
*
|
||||
* A collaboration between Symfony and the PHP Foundation.
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Mcp\Example\Server\DiscoveryUserProfile;
|
||||
|
||||
use Mcp\Capability\Attribute\CompletionProvider;
|
||||
use Mcp\Capability\Attribute\McpPrompt;
|
||||
use Mcp\Capability\Attribute\McpResource;
|
||||
use Mcp\Capability\Attribute\McpResourceTemplate;
|
||||
use Mcp\Capability\Attribute\McpTool;
|
||||
use Mcp\Exception\PromptGetException;
|
||||
use Mcp\Exception\ResourceReadException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* @phpstan-type User array{name: string, email: string, role: string}
|
||||
*/
|
||||
final class McpElements
|
||||
{
|
||||
/**
|
||||
* Simulate a simple user database.
|
||||
*
|
||||
* @var array<int, User>
|
||||
*/
|
||||
private array $users = [
|
||||
'101' => ['name' => 'Alice', 'email' => 'alice@example.com', 'role' => 'admin'],
|
||||
'102' => ['name' => 'Bob', 'email' => 'bob@example.com', 'role' => 'user'],
|
||||
'103' => ['name' => 'Charlie', 'email' => 'charlie@example.com', 'role' => 'user'],
|
||||
];
|
||||
|
||||
public function __construct(
|
||||
private readonly LoggerInterface $logger,
|
||||
) {
|
||||
$this->logger->debug('DiscoveryUserProfile McpElements instantiated.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the profile data for a specific user.
|
||||
*
|
||||
* @param string $userId the ID of the user (from URI)
|
||||
*
|
||||
* @return User user profile data
|
||||
*
|
||||
* @throws ResourceReadException if the user is not found
|
||||
*/
|
||||
#[McpResourceTemplate(
|
||||
uriTemplate: 'user://{userId}/profile',
|
||||
name: 'user_profile',
|
||||
description: 'Get profile information for a specific user ID.',
|
||||
mimeType: 'application/json'
|
||||
)]
|
||||
public function getUserProfile(
|
||||
#[CompletionProvider(values: ['101', '102', '103'])]
|
||||
string $userId,
|
||||
): array {
|
||||
$this->logger->info('Reading resource: user profile', ['userId' => $userId]);
|
||||
if (!isset($this->users[$userId])) {
|
||||
throw new ResourceReadException("User not found for ID: {$userId}");
|
||||
}
|
||||
|
||||
return $this->users[$userId];
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a list of all known user IDs.
|
||||
*
|
||||
* @return int[] list of user IDs
|
||||
*/
|
||||
#[McpResource(
|
||||
uri: 'user://list/ids',
|
||||
name: 'user_id_list',
|
||||
description: 'Provides a list of all available user IDs.',
|
||||
mimeType: 'application/json'
|
||||
)]
|
||||
public function listUserIds(): array
|
||||
{
|
||||
$this->logger->info('Reading resource: user ID list');
|
||||
|
||||
return array_keys($this->users);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a welcome message to a user.
|
||||
* (This is a placeholder - in a real app, it might queue an email).
|
||||
*
|
||||
* @param string $userId the ID of the user to message
|
||||
* @param string|null $customMessage an optional custom message part
|
||||
*
|
||||
* @return array<string, bool|string> status of the operation
|
||||
*/
|
||||
#[McpTool(name: 'send_welcome')]
|
||||
public function sendWelcomeMessage(string $userId, ?string $customMessage = null): array
|
||||
{
|
||||
$this->logger->info('Executing tool: send_welcome', ['userId' => $userId]);
|
||||
if (!isset($this->users[$userId])) {
|
||||
return ['success' => false, 'error' => "User ID {$userId} not found."];
|
||||
}
|
||||
$user = $this->users[$userId];
|
||||
$message = "Welcome, {$user['name']}!";
|
||||
if ($customMessage) {
|
||||
$message .= ' '.$customMessage;
|
||||
}
|
||||
// Simulate sending
|
||||
$this->logger->info("Simulated sending message to {$user['email']}: {$message}");
|
||||
|
||||
return ['success' => true, 'message_sent' => $message];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, bool|string>
|
||||
*/
|
||||
#[McpTool(name: 'test_tool_without_params')]
|
||||
public function testToolWithoutParams(): array
|
||||
{
|
||||
return ['success' => true, 'message' => 'Test tool without params'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a prompt to write a bio for a user.
|
||||
*
|
||||
* @param string $userId the user ID to generate the bio for
|
||||
* @param string $tone Desired tone (e.g., 'formal', 'casual').
|
||||
*
|
||||
* @return array<string, string>[] prompt messages
|
||||
*
|
||||
* @throws PromptGetException if user not found
|
||||
*/
|
||||
#[McpPrompt(name: 'generate_bio_prompt')]
|
||||
public function generateBio(
|
||||
#[CompletionProvider(provider: UserIdCompletionProvider::class)]
|
||||
string $userId,
|
||||
string $tone = 'professional',
|
||||
): array {
|
||||
$this->logger->info('Executing prompt: generate_bio', ['userId' => $userId, 'tone' => $tone]);
|
||||
if (!isset($this->users[$userId])) {
|
||||
throw new PromptGetException("User not found for bio prompt: {$userId}");
|
||||
}
|
||||
$user = $this->users[$userId];
|
||||
|
||||
return [
|
||||
['role' => 'user', 'content' => "Write a short, {$tone} biography for {$user['name']} (Role: {$user['role']}, Email: {$user['email']}). Highlight their role within the system."],
|
||||
];
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the official PHP MCP SDK.
|
||||
*
|
||||
* A collaboration between Symfony and the PHP Foundation.
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Mcp\Example\Server\DiscoveryUserProfile;
|
||||
|
||||
use Mcp\Capability\Completion\ProviderInterface;
|
||||
|
||||
final class UserIdCompletionProvider implements ProviderInterface
|
||||
{
|
||||
private const AVAILABLE_USER_IDS = ['101', '102', '103'];
|
||||
|
||||
public function getCompletions(string $currentValue): array
|
||||
{
|
||||
return array_filter(self::AVAILABLE_USER_IDS, fn (string $userId) => str_contains($userId, $currentValue));
|
||||
}
|
||||
}
|
||||
71
examples/server/discovery-userprofile/server.php
Normal file
71
examples/server/discovery-userprofile/server.php
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
#!/usr/bin/env php
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the official PHP MCP SDK.
|
||||
*
|
||||
* A collaboration between Symfony and the PHP Foundation.
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once dirname(__DIR__).'/bootstrap.php';
|
||||
chdir(__DIR__);
|
||||
|
||||
use Mcp\Server;
|
||||
use Mcp\Server\Session\FileSessionStore;
|
||||
|
||||
$server = Server::builder()
|
||||
->setServerInfo('HTTP User Profiles', '1.0.0')
|
||||
->setLogger(logger())
|
||||
->setContainer(container())
|
||||
->setSession(new FileSessionStore(__DIR__.'/sessions'))
|
||||
->setDiscovery(__DIR__)
|
||||
->addTool(
|
||||
function (float $a, float $b, string $operation = 'add'): array {
|
||||
$result = match ($operation) {
|
||||
'add' => $a + $b,
|
||||
'subtract' => $a - $b,
|
||||
'multiply' => $a * $b,
|
||||
'divide' => 0 != $b ? $a / $b : throw new InvalidArgumentException('Cannot divide by zero'),
|
||||
default => throw new InvalidArgumentException("Unknown operation: {$operation}"),
|
||||
};
|
||||
|
||||
return [
|
||||
'operation' => $operation,
|
||||
'operands' => [$a, $b],
|
||||
'result' => $result,
|
||||
];
|
||||
},
|
||||
name: 'calculator',
|
||||
description: 'Perform basic math operations (add, subtract, multiply, divide)'
|
||||
)
|
||||
->addResource(
|
||||
function (): array {
|
||||
$memoryUsage = memory_get_usage(true);
|
||||
$memoryPeak = memory_get_peak_usage(true);
|
||||
$uptime = time() - ($_SERVER['REQUEST_TIME_FLOAT'] ?? time());
|
||||
$serverSoftware = $_SERVER['SERVER_SOFTWARE'] ?? 'CLI';
|
||||
|
||||
return [
|
||||
'server_time' => date('Y-m-d H:i:s'),
|
||||
'uptime_seconds' => $uptime,
|
||||
'memory_usage_mb' => round($memoryUsage / 1024 / 1024, 2),
|
||||
'memory_peak_mb' => round($memoryPeak / 1024 / 1024, 2),
|
||||
'php_version' => \PHP_VERSION,
|
||||
'server_software' => $serverSoftware,
|
||||
'operating_system' => \PHP_OS_FAMILY,
|
||||
'status' => 'healthy',
|
||||
];
|
||||
},
|
||||
uri: 'system://status',
|
||||
name: 'system_status',
|
||||
description: 'Current system status and runtime information',
|
||||
mimeType: 'application/json'
|
||||
)
|
||||
->build();
|
||||
|
||||
$response = $server->run(transport());
|
||||
|
||||
shutdown($response);
|
||||
Loading…
Reference in a new issue