Skip to content

Commit 8836c40

Browse files
bigdevlarrybigdevlarry
committed
Add missing handler for resource subscribe and unsubscribe
Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe Add missing handler for resource subscribe and unsubscribe
1 parent 940eb90 commit 8836c40

16 files changed

Lines changed: 975 additions & 10 deletions

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
All notable changes to `mcp/sdk` will be documented in this file.
44

5+
0.4.0
6+
-----
7+
* Add missing handlers for resource subscribe/unsubscribe and persist subscriptions via session
8+
59
0.3.0
610
-----
711

‎src/Capability/Registry.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ public function getDiscoveryState(): DiscoveryState
352352
}
353353

354354
/**
355-
* Set discovery state, replacing all discovered elements.
355+
* Set the discovery state, replacing all discovered elements.
356356
* Manual elements are preserved.
357357
*/
358358
public function setDiscoveryState(DiscoveryState $state): void

‎src/Server/Builder.php‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
use Mcp\Server;
3434
use Mcp\Server\Handler\Notification\NotificationHandlerInterface;
3535
use Mcp\Server\Handler\Request\RequestHandlerInterface;
36+
use Mcp\Server\Resource\SessionSubscriptionManager;
37+
use Mcp\Server\Resource\SubscriptionManagerInterface;
3638
use Mcp\Server\Session\InMemorySessionStore;
3739
use Mcp\Server\Session\SessionFactory;
3840
use Mcp\Server\Session\SessionFactoryInterface;
@@ -54,6 +56,8 @@ final class Builder
5456

5557
private RegistryInterface $registry;
5658

59+
private ?SubscriptionManagerInterface $subscriptionManager = null;
60+
5761
private ?LoggerInterface $logger = null;
5862

5963
private ?CacheInterface $discoveryCache = null;
@@ -309,6 +313,13 @@ public function setDiscoverer(DiscovererInterface $discoverer): self
309313
return $this;
310314
}
311315

316+
public function setResourceSubscriptionManager(SubscriptionManagerInterface $subscriptionManager): self
317+
{
318+
$this->subscriptionManager = $subscriptionManager;
319+
320+
return $this;
321+
}
322+
312323
public function setSession(
313324
SessionStoreInterface $sessionStore,
314325
SessionFactoryInterface $sessionFactory = new SessionFactory(),
@@ -490,6 +501,16 @@ public function build(): Server
490501
$container = $this->container ?? new Container();
491502
$registry = $this->registry ?? new Registry($this->eventDispatcher, $logger);
492503

504+
$sessionTtl = $this->sessionTtl ?? 3600;
505+
$sessionFactory = $this->sessionFactory ?? new SessionFactory();
506+
$sessionStore = $this->sessionStore ?? new InMemorySessionStore($sessionTtl);
507+
508+
$subscriptionManager = $this->subscriptionManager ?? new SessionSubscriptionManager(
509+
$logger,
510+
$sessionStore,
511+
$sessionFactory
512+
);
513+
493514
$loaders = [
494515
...$this->loaders,
495516
new ArrayLoader($this->tools, $this->resources, $this->resourceTemplates, $this->prompts, $logger, $this->schemaGenerator),
@@ -504,16 +525,13 @@ public function build(): Server
504525
$loader->load($registry);
505526
}
506527

507-
$sessionTtl = $this->sessionTtl ?? 3600;
508-
$sessionFactory = $this->sessionFactory ?? new SessionFactory();
509-
$sessionStore = $this->sessionStore ?? new InMemorySessionStore($sessionTtl);
510528
$messageFactory = MessageFactory::make();
511529

512530
$capabilities = $this->serverCapabilities ?? new ServerCapabilities(
513531
tools: $registry->hasTools(),
514532
toolsListChanged: $this->eventDispatcher instanceof EventDispatcherInterface,
515533
resources: $registry->hasResources() || $registry->hasResourceTemplates(),
516-
resourcesSubscribe: false,
534+
resourcesSubscribe: $registry->hasResources() || $registry->hasResourceTemplates(),
517535
resourcesListChanged: $this->eventDispatcher instanceof EventDispatcherInterface,
518536
prompts: $registry->hasPrompts(),
519537
promptsListChanged: $this->eventDispatcher instanceof EventDispatcherInterface,
@@ -536,6 +554,8 @@ public function build(): Server
536554
new Handler\Request\ListToolsHandler($registry, $this->paginationLimit),
537555
new Handler\Request\PingHandler(),
538556
new Handler\Request\ReadResourceHandler($registry, $referenceHandler, $logger),
557+
new Handler\Request\ResourceSubscribeHandler($registry, $subscriptionManager, $logger),
558+
new Handler\Request\ResourceUnsubscribeHandler($registry, $subscriptionManager, $logger),
539559
new Handler\Request\SetLogLevelHandler(),
540560
]);
541561

‎src/Server/Handler/Request/ResourceSubscribeHandler.php‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the official PHP MCP SDK.
5+
*
6+
* A collaboration between Symfony and the PHP Foundation.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Mcp\Server\Handler\Request;
13+
14+
use Mcp\Capability\RegistryInterface;
15+
use Mcp\Exception\ResourceNotFoundException;
16+
use Mcp\Schema\JsonRpc\Error;
17+
use Mcp\Schema\JsonRpc\Request;
18+
use Mcp\Schema\JsonRpc\Response;
19+
use Mcp\Schema\Request\ResourceSubscribeRequest;
20+
use Mcp\Schema\Result\EmptyResult;
21+
use Mcp\Server\Resource\SubscriptionManagerInterface;
22+
use Mcp\Server\Session\SessionInterface;
23+
use Psr\Log\LoggerInterface;
24+
use Psr\Log\NullLogger;
25+
use Psr\SimpleCache\InvalidArgumentException;
26+
27+
/**
28+
* @implements RequestHandlerInterface<EmptyResult>
29+
*
30+
* @author Larry Sule-balogun <suleabimbola@gmail.com>
31+
*/
32+
final class ResourceSubscribeHandler implements RequestHandlerInterface
33+
{
34+
public function __construct(
35+
private readonly RegistryInterface $registry,
36+
private readonly SubscriptionManagerInterface $subscriptionManager,
37+
private readonly LoggerInterface $logger = new NullLogger(),
38+
) {
39+
}
40+
41+
public function supports(Request $request): bool
42+
{
43+
return $request instanceof ResourceSubscribeRequest;
44+
}
45+
46+
/**
47+
* @throws InvalidArgumentException
48+
*/
49+
public function handle(Request $request, SessionInterface $session): Response|Error
50+
{
51+
\assert($request instanceof ResourceSubscribeRequest);
52+
53+
$uri = $request->uri;
54+
55+
try {
56+
$this->registry->getResource($uri);
57+
} catch (ResourceNotFoundException $e) {
58+
$this->logger->error('Resource not found', ['uri' => $uri]);
59+
60+
return Error::forResourceNotFound($e->getMessage(), $request->getId());
61+
}
62+
63+
$this->logger->debug('Subscribing to resource', ['uri' => $uri]);
64+
65+
$this->subscriptionManager->subscribe($session, $uri);
66+
67+
return new Response(
68+
$request->getId(),
69+
new EmptyResult(),
70+
);
71+
}
72+
}

‎src/Server/Handler/Request/ResourceUnsubscribeHandler.php‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the official PHP MCP SDK.
5+
*
6+
* A collaboration between Symfony and the PHP Foundation.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Mcp\Server\Handler\Request;
13+
14+
use Mcp\Capability\RegistryInterface;
15+
use Mcp\Exception\ResourceNotFoundException;
16+
use Mcp\Schema\JsonRpc\Error;
17+
use Mcp\Schema\JsonRpc\Request;
18+
use Mcp\Schema\JsonRpc\Response;
19+
use Mcp\Schema\Request\ResourceUnsubscribeRequest;
20+
use Mcp\Schema\Result\EmptyResult;
21+
use Mcp\Server\Resource\SubscriptionManagerInterface;
22+
use Mcp\Server\Session\SessionInterface;
23+
use Psr\Log\LoggerInterface;
24+
use Psr\Log\NullLogger;
25+
use Psr\SimpleCache\InvalidArgumentException;
26+
27+
/**
28+
* @implements RequestHandlerInterface<EmptyResult>
29+
*
30+
* @author Larry Sule-balogun <suleabimbola@gmail.com>
31+
*/
32+
final class ResourceUnsubscribeHandler implements RequestHandlerInterface
33+
{
34+
public function __construct(
35+
private readonly RegistryInterface $registry,
36+
private readonly SubscriptionManagerInterface $subscriptionManager,
37+
private readonly LoggerInterface $logger = new NullLogger(),
38+
) {
39+
}
40+
41+
public function supports(Request $request): bool
42+
{
43+
return $request instanceof ResourceUnsubscribeRequest;
44+
}
45+
46+
/**
47+
* @throws InvalidArgumentException
48+
*/
49+
public function handle(Request $request, SessionInterface $session): Response|Error
50+
{
51+
\assert($request instanceof ResourceUnsubscribeRequest);
52+
53+
$uri = $request->uri;
54+
55+
try {
56+
$this->registry->getResource($uri);
57+
} catch (ResourceNotFoundException $e) {
58+
$this->logger->error('Resource not found', ['uri' => $uri]);
59+
60+
return Error::forResourceNotFound($e->getMessage(), $request->getId());
61+
}
62+
63+
$this->logger->debug('Unsubscribing from resource', ['uri' => $uri]);
64+
65+
$this->subscriptionManager->unsubscribe($session, $uri);
66+
67+
return new Response(
68+
$request->getId(),
69+
new EmptyResult(),
70+
);
71+
}
72+
}

‎src/Server/Resource/SessionSubscriptionManager.php‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the official PHP MCP SDK.
5+
*
6+
* A collaboration between Symfony and the PHP Foundation.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Mcp\Server\Resource;
13+
14+
use Mcp\Schema\Notification\ResourceUpdatedNotification;
15+
use Mcp\Server\Protocol;
16+
use Mcp\Server\Session\SessionFactoryInterface;
17+
use Mcp\Server\Session\SessionInterface;
18+
use Mcp\Server\Session\SessionStoreInterface;
19+
use Psr\Log\LoggerInterface;
20+
use Psr\Log\NullLogger;
21+
use Psr\SimpleCache\InvalidArgumentException;
22+
23+
/**
24+
* The default Subscription manager implementation manages subscriptions per session only.
25+
* It is in-memory and does not support cross-session or cross-client subscriptions.
26+
*
27+
* The SDK allows injecting alternative SubscriptionManagerInterface
28+
* implementations via Builder::setResourceSubscriptionManager().
29+
*
30+
* @author Larry Sule-balogun <suleabimbola@gmail.com>
31+
*/
32+
final class SessionSubscriptionManager implements SubscriptionManagerInterface
33+
{
34+
public function __construct(
35+
private readonly LoggerInterface $logger = new NullLogger(),
36+
private readonly ?SessionStoreInterface $sessionStore = null,
37+
private readonly ?SessionFactoryInterface $sessionFactory = null,
38+
) {
39+
}
40+
41+
/**
42+
* @throws InvalidArgumentException
43+
*/
44+
public function subscribe(SessionInterface $session, string $uri): void
45+
{
46+
$subscriptions = $session->get('resource_subscriptions', []);
47+
$subscriptions[$uri] = true;
48+
$session->set('resource_subscriptions', $subscriptions);
49+
$session->save();
50+
}
51+
52+
/**
53+
* @throws InvalidArgumentException
54+
*/
55+
public function unsubscribe(SessionInterface $session, string $uri): void
56+
{
57+
$subscriptions = $session->get('resource_subscriptions', []);
58+
unset($subscriptions[$uri]);
59+
$session->set('resource_subscriptions', $subscriptions);
60+
$session->save();
61+
}
62+
63+
/**
64+
* @throws InvalidArgumentException
65+
*/
66+
public function notifyResourceChanged(Protocol $protocol, string $uri): void
67+
{
68+
if (!$this->sessionStore || !$this->sessionFactory) {
69+
$this->logger->warning('Cannot send resource notifications: session store or factory not configured.');
70+
71+
return;
72+
}
73+
74+
foreach ($this->sessionStore->getAllSessionIds() as $sessionId) {
75+
try {
76+
$sessionData = $this->sessionStore->read($sessionId);
77+
if (!$sessionData) {
78+
continue;
79+
}
80+
81+
$sessionArray = json_decode($sessionData, true);
82+
if (!\is_array($sessionArray)) {
83+
continue;
84+
}
85+
86+
if (!isset($sessionArray['resource_subscriptions'][$uri])) {
87+
continue;
88+
}
89+
90+
$session = $this->sessionFactory->createWithId($sessionId, $this->sessionStore);
91+
$protocol->sendNotification(new ResourceUpdatedNotification($uri), $session);
92+
} catch (InvalidArgumentException $e) {
93+
$this->logger->error('Error sending resource notification to session', [
94+
'session_id' => $sessionId->toRfc4122(),
95+
'uri' => $uri,
96+
'exception' => $e,
97+
]);
98+
}
99+
}
100+
}
101+
}

‎src/Server/Resource/SubscriptionManagerInterface.php‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the official PHP MCP SDK.
5+
*
6+
* A collaboration between Symfony and the PHP Foundation.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Mcp\Server\Resource;
13+
14+
use Mcp\Server\Protocol;
15+
use Mcp\Server\Session\SessionInterface;
16+
use Psr\SimpleCache\InvalidArgumentException;
17+
18+
/**
19+
* Resource subscription interface.
20+
*
21+
* @author Larry Sule-balogun <suleabimbola@gmail.com>
22+
*/
23+
interface SubscriptionManagerInterface
24+
{
25+
/**
26+
* Subscribes a session to a specific resource URI.
27+
*
28+
* @throws InvalidArgumentException
29+
*/
30+
public function subscribe(SessionInterface $session, string $uri): void;
31+
32+
/**
33+
* Unsubscribes a session from a specific resource URI.
34+
*
35+
* @throws InvalidArgumentException
36+
*/
37+
public function unsubscribe(SessionInterface $session, string $uri): void;
38+
39+
/**
40+
* Notifies all sessions subscribed to the given resource URI that the
41+
* resource has changed. Sends a ResourceUpdatedNotification for each subscriber.
42+
*
43+
* @throws InvalidArgumentException
44+
*/
45+
public function notifyResourceChanged(Protocol $protocol, string $uri): void;
46+
}

0 commit comments

Comments
 (0)