[Server] Simplify server entrypoint with run-based transport lifecycle (#103)
* feat: replace connect/listen flow with run lifecycle * feat(transport): add phpstan generics for typed transport returns * refactor: standardize variable naming for MCP server instances in transport handling * test: remove unnecessary phpstan-ignore annotation in DocBlockTestFixture
This commit is contained in:
parent
e2243bc2d9
commit
2dbd411194
19 changed files with 82 additions and 74 deletions
10
README.md
10
README.md
|
|
@ -108,8 +108,8 @@ $server = Server::builder()
|
|||
->build();
|
||||
|
||||
$transport = new StdioTransport();
|
||||
$server->connect($transport);
|
||||
$transport->listen();
|
||||
|
||||
$server->run($transport);
|
||||
```
|
||||
|
||||
### 3. Configure Your MCP Client
|
||||
|
|
@ -175,15 +175,13 @@ $server = Server::builder()
|
|||
**STDIO Transport** (Command-line integration):
|
||||
```php
|
||||
$transport = new StdioTransport();
|
||||
$server->connect($transport);
|
||||
$transport->listen();
|
||||
$server->run($transport);
|
||||
```
|
||||
|
||||
**HTTP Transport** (Web-based communication):
|
||||
```php
|
||||
$transport = new StreamableHttpTransport($request, $responseFactory, $streamFactory);
|
||||
$server->connect($transport);
|
||||
$response = $transport->listen();
|
||||
$response = $server->run($transport);
|
||||
// Handle $response in your web application
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -22,9 +22,7 @@ $server = Server::builder()
|
|||
|
||||
$transport = new SomeTransport();
|
||||
|
||||
$server->connect($transport);
|
||||
|
||||
$transport->listen(); // For STDIO, or handle response for HTTP
|
||||
$result = $server->run($transport); // Blocks for STDIO, returns a response for HTTP
|
||||
```
|
||||
|
||||
## STDIO Transport
|
||||
|
|
@ -70,9 +68,9 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport();
|
||||
|
||||
$server->connect($transport);
|
||||
$status = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
exit($status); // 0 on clean shutdown, non-zero if STDIN errored
|
||||
```
|
||||
|
||||
### Client Configuration
|
||||
|
|
@ -138,24 +136,20 @@ use Nyholm\Psr7\Factory\Psr17Factory;
|
|||
use Nyholm\Psr7Server\ServerRequestCreator;
|
||||
use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
|
||||
|
||||
// Create PSR-7 request from globals
|
||||
$psr17Factory = new Psr17Factory();
|
||||
$creator = new ServerRequestCreator($psr17Factory, $psr17Factory, $psr17Factory, $psr17Factory);
|
||||
$request = $creator->fromGlobals();
|
||||
|
||||
// Build server
|
||||
$server = Server::builder()
|
||||
->setServerInfo('HTTP Server', '1.0.0')
|
||||
->setDiscovery(__DIR__, ['.'])
|
||||
->setSession(new FileSessionStore(__DIR__ . '/sessions')) // HTTP needs persistent sessions
|
||||
->build();
|
||||
|
||||
// Process request and get response
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
$server->connect($transport);
|
||||
$response = $transport->listen();
|
||||
|
||||
// Emit response
|
||||
$response = $server->run($transport);
|
||||
|
||||
(new SapiEmitter())->emit($response);
|
||||
```
|
||||
|
||||
|
|
@ -187,7 +181,7 @@ use Mcp\Server\Transport\StreamableHttpTransport;
|
|||
class McpController
|
||||
{
|
||||
#[Route('/mcp', name: 'mcp_endpoint']
|
||||
public function handle(Request $request, Server $mcpServer): Response
|
||||
public function handle(Request $request, Server $server): Response
|
||||
{
|
||||
// Create PSR-7 factories
|
||||
$psr17Factory = new Psr17Factory();
|
||||
|
|
@ -199,8 +193,7 @@ class McpController
|
|||
|
||||
// Process with MCP
|
||||
$transport = new StreamableHttpTransport($psrRequest, $psr17Factory, $psr17Factory);
|
||||
$mcpServer->connect($transport);
|
||||
$psrResponse = $transport->listen();
|
||||
$psrResponse = $server->run($transport);
|
||||
|
||||
// Convert PSR-7 response back to Symfony
|
||||
return $httpFoundationFactory->createResponse($psrResponse);
|
||||
|
|
@ -230,17 +223,16 @@ use Nyholm\Psr7\Factory\Psr17Factory;
|
|||
|
||||
class McpController
|
||||
{
|
||||
public function handle(ServerRequestInterface $request, Server $mcpServer): ResponseInterface
|
||||
public function handle(ServerRequestInterface $request, Server $server): ResponseInterface
|
||||
{
|
||||
$psr17Factory = new Psr17Factory();
|
||||
|
||||
// Create and connect the MCP HTTP transport
|
||||
// Create the MCP HTTP transport
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
$mcpServer->connect($transport);
|
||||
|
||||
// Process MCP request and return PSR-7 response
|
||||
// Laravel automatically handles PSR-7 responses
|
||||
return $transport->listen();
|
||||
return $server->run($transport);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -255,7 +247,6 @@ Slim Framework works natively with PSR-7.
|
|||
Create a route handler using Slim's built-in factories and container:
|
||||
|
||||
```php
|
||||
use Psr\Container\ContainerInterface;
|
||||
use Slim\Factory\AppFactory;
|
||||
use Slim\Psr7\Factory\ResponseFactory;
|
||||
use Slim\Psr7\Factory\StreamFactory;
|
||||
|
|
@ -263,25 +254,19 @@ use Mcp\Server;
|
|||
use Mcp\Server\Transport\StreamableHttpTransport;
|
||||
|
||||
$app = AppFactory::create();
|
||||
$container = $app->getContainer();
|
||||
|
||||
$container->set('mcpServer', function (ContainerInterface $container) {
|
||||
return Server::builder()
|
||||
$app->any('/mcp', function ($request, $response) {
|
||||
$server = Server::builder()
|
||||
->setServerInfo('My MCP Server', '1.0.0')
|
||||
->setDiscovery(__DIR__, ['.'])
|
||||
->build();
|
||||
});
|
||||
|
||||
$app->any('/mcp', function ($request, $response) {
|
||||
$mcpServer = $this->get('mcpServer');
|
||||
|
||||
$responseFactory = new ResponseFactory();
|
||||
$streamFactory = new StreamFactory();
|
||||
|
||||
$transport = new StreamableHttpTransport($request, $responseFactory, $streamFactory);
|
||||
$mcpServer->connect($transport);
|
||||
|
||||
return $transport->listen();
|
||||
return $server->run($transport);
|
||||
});
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -137,8 +137,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -42,8 +42,6 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
|
||||
$server->connect($transport);
|
||||
|
||||
$response = $transport->listen();
|
||||
$response = $server->run($transport);
|
||||
|
||||
(new SapiEmitter())->emit($response);
|
||||
|
|
|
|||
|
|
@ -35,8 +35,6 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
|
||||
$server->connect($transport);
|
||||
|
||||
$response = $transport->listen();
|
||||
$response = $server->run($transport);
|
||||
|
||||
(new SapiEmitter())->emit($response);
|
||||
|
|
|
|||
|
|
@ -77,8 +77,6 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
|
||||
$server->connect($transport);
|
||||
|
||||
$response = $transport->listen();
|
||||
$response = $server->run($transport);
|
||||
|
||||
(new SapiEmitter())->emit($response);
|
||||
|
|
|
|||
|
|
@ -35,8 +35,6 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StreamableHttpTransport($request, $psr17Factory, $psr17Factory);
|
||||
|
||||
$server->connect($transport);
|
||||
|
||||
$response = $transport->listen();
|
||||
$response = $server->run($transport);
|
||||
|
||||
(new SapiEmitter())->emit($response);
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -39,8 +39,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -57,8 +57,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@ $server = Server::builder()
|
|||
|
||||
$transport = new StdioTransport(logger: logger());
|
||||
|
||||
$server->connect($transport);
|
||||
$result = $server->run($transport);
|
||||
|
||||
$transport->listen();
|
||||
logger()->info('Server listener stopped gracefully.', ['result' => $result]);
|
||||
|
||||
logger()->info('Server listener stopped gracefully.');
|
||||
exit($result);
|
||||
|
|
|
|||
|
|
@ -35,7 +35,14 @@ final class Server
|
|||
return new Builder();
|
||||
}
|
||||
|
||||
public function connect(TransportInterface $transport): void
|
||||
/**
|
||||
* @template TResult
|
||||
*
|
||||
* @param TransportInterface<TResult> $transport
|
||||
*
|
||||
* @return TResult
|
||||
*/
|
||||
public function run(TransportInterface $transport): mixed
|
||||
{
|
||||
$transport->initialize();
|
||||
|
||||
|
|
@ -56,5 +63,11 @@ final class Server
|
|||
$transport->onSessionEnd(function (Uuid $sessionId) {
|
||||
$this->jsonRpcHandler->destroySession($sessionId);
|
||||
});
|
||||
|
||||
try {
|
||||
return $transport->listen();
|
||||
} finally {
|
||||
$transport->close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ namespace Mcp\Server\Transport;
|
|||
use Symfony\Component\Uid\Uuid;
|
||||
|
||||
/**
|
||||
* @implements TransportInterface<null>
|
||||
*
|
||||
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
|
||||
*/
|
||||
class InMemoryTransport implements TransportInterface
|
||||
|
|
@ -50,6 +52,9 @@ class InMemoryTransport implements TransportInterface
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return null
|
||||
*/
|
||||
public function listen(): mixed
|
||||
{
|
||||
foreach ($this->messages as $message) {
|
||||
|
|
@ -60,6 +65,7 @@ class InMemoryTransport implements TransportInterface
|
|||
|
||||
if (\is_callable($this->sessionDestroyListener) && null !== $this->sessionId) {
|
||||
\call_user_func($this->sessionDestroyListener, $this->sessionId);
|
||||
$this->sessionId = null;
|
||||
}
|
||||
|
||||
return null;
|
||||
|
|
@ -74,6 +80,7 @@ class InMemoryTransport implements TransportInterface
|
|||
{
|
||||
if (\is_callable($this->sessionDestroyListener) && null !== $this->sessionId) {
|
||||
\call_user_func($this->sessionDestroyListener, $this->sessionId);
|
||||
$this->sessionId = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,6 +16,8 @@ use Psr\Log\NullLogger;
|
|||
use Symfony\Component\Uid\Uuid;
|
||||
|
||||
/**
|
||||
* @implements TransportInterface<int>
|
||||
*
|
||||
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
|
||||
*/
|
||||
class StdioTransport implements TransportInterface
|
||||
|
|
@ -59,13 +61,18 @@ class StdioTransport implements TransportInterface
|
|||
fwrite($this->output, $data.\PHP_EOL);
|
||||
}
|
||||
|
||||
public function listen(): mixed
|
||||
public function listen(): int
|
||||
{
|
||||
$this->logger->info('StdioTransport is listening for messages on STDIN...');
|
||||
|
||||
$status = 0;
|
||||
while (!feof($this->input)) {
|
||||
$line = fgets($this->input);
|
||||
if (false === $line) {
|
||||
if (!feof($this->input)) {
|
||||
$status = 1;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
|
|
@ -82,9 +89,10 @@ class StdioTransport implements TransportInterface
|
|||
|
||||
if (\is_callable($this->sessionEndListener) && null !== $this->sessionId) {
|
||||
\call_user_func($this->sessionEndListener, $this->sessionId);
|
||||
$this->sessionId = null;
|
||||
}
|
||||
|
||||
return null;
|
||||
return $status;
|
||||
}
|
||||
|
||||
public function onSessionEnd(callable $listener): void
|
||||
|
|
@ -96,6 +104,7 @@ class StdioTransport implements TransportInterface
|
|||
{
|
||||
if (\is_callable($this->sessionEndListener) && null !== $this->sessionId) {
|
||||
\call_user_func($this->sessionEndListener, $this->sessionId);
|
||||
$this->sessionId = null;
|
||||
}
|
||||
|
||||
if (\is_resource($this->input)) {
|
||||
|
|
|
|||
|
|
@ -21,6 +21,8 @@ use Psr\Log\NullLogger;
|
|||
use Symfony\Component\Uid\Uuid;
|
||||
|
||||
/**
|
||||
* @implements TransportInterface<ResponseInterface>
|
||||
*
|
||||
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
|
||||
*/
|
||||
class StreamableHttpTransport implements TransportInterface
|
||||
|
|
@ -78,7 +80,7 @@ class StreamableHttpTransport implements TransportInterface
|
|||
]);
|
||||
}
|
||||
|
||||
public function listen(): mixed
|
||||
public function listen(): ResponseInterface
|
||||
{
|
||||
return match ($this->request->getMethod()) {
|
||||
'OPTIONS' => $this->handleOptionsRequest(),
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ namespace Mcp\Server\Transport;
|
|||
use Symfony\Component\Uid\Uuid;
|
||||
|
||||
/**
|
||||
* @template TResult
|
||||
*
|
||||
* @author Christopher Hertel <mail@christopher-hertel.de>
|
||||
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
|
||||
*/
|
||||
|
|
@ -38,7 +40,7 @@ interface TransportInterface
|
|||
* - For a single-request transport like HTTP, this will process the request
|
||||
* and return a result (e.g., a PSR-7 Response) to be sent to the client.
|
||||
*
|
||||
* @return mixed the result of the transport's execution, if any
|
||||
* @return TResult the result of the transport's execution, if any
|
||||
*/
|
||||
public function listen(): mixed;
|
||||
|
||||
|
|
@ -63,6 +65,7 @@ interface TransportInterface
|
|||
*
|
||||
* This method should be called when the transport is no longer needed.
|
||||
* It should clean up any resources and close any connections.
|
||||
* `Server::run()` calls this automatically after `listen()` exits.
|
||||
*/
|
||||
public function close(): void;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ class DocBlockTestFixture
|
|||
* @deprecated use newMethod() instead
|
||||
* @see DocBlockTestFixture::newMethod()
|
||||
*/
|
||||
public function methodWithMultipleTags(float $value): bool /* @phpstan-ignore throws.unusedType */
|
||||
public function methodWithMultipleTags(float $value): bool
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -32,16 +32,15 @@ class ServerTest extends TestCase
|
|||
|
||||
$transport = $this->getMockBuilder(InMemoryTransport::class)
|
||||
->setConstructorArgs([['foo', 'bar']])
|
||||
->onlyMethods(['send'])
|
||||
->onlyMethods(['send', 'close'])
|
||||
->getMock();
|
||||
$transport->expects($this->exactly(2))->method('send')->willReturnOnConsecutiveCalls(
|
||||
null,
|
||||
null
|
||||
);
|
||||
$transport->expects($this->once())->method('close');
|
||||
|
||||
$server = new Server($handler);
|
||||
$server->connect($transport);
|
||||
|
||||
$transport->listen();
|
||||
$server->run($transport);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue