-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathMcpConnection.php
More file actions
425 lines (361 loc) · 10.6 KB
/
Copy pathMcpConnection.php
File metadata and controls
425 lines (361 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
<?php
namespace Swis\Agents\Mcp;
use Closure;
use Psr\Cache\CacheItemPoolInterface;
use Swis\Agents\Exceptions\HandleToolException;
use Swis\Agents\Interfaces\McpConnectionInterface;
use Swis\Agents\Tool;
use Swis\McpClient\Client;
use Swis\McpClient\Requests\BaseRequest;
use Swis\McpClient\Requests\CallToolRequest;
use Swis\McpClient\Requests\ListToolsRequest;
use Swis\McpClient\Results\CallToolResult;
use Swis\McpClient\Results\JsonRpcError;
use Swis\McpClient\Schema\Content\TextContent;
use Throwable;
/**
* Represents a connection to an MCP server.
*
* This class manages the connection with an MCP server and provides
* access to its tools and functionality.
*/
class McpConnection implements McpConnectionInterface
{
/**
* @var array<string> Allowed tool names for this MCP connection
*/
protected array $allowedToolNames = [];
/**
* @var array<McpTool>|null Cached tools from the MCP server
*/
protected ?array $tools = null;
/**
* @var string The cache key for storing MCP tools
*/
protected string $cacheKey = 'mcp_tools';
/**
* @var int Cache lifetime in seconds (default: 1 hour)
*/
protected int $cacheTtl = 3600;
/**
* The metadata that will be sent with each MCP request.
*
* @var array<string, mixed>|Closure
*/
protected array|Closure $meta = [];
/**
* Constructor
*
* @param Client $client The MCP client
* @param string $name Connection name for identification
* @param CacheItemPoolInterface|null $cache PSR-6 cache implementation
*/
public function __construct(
protected Client $client,
protected string $name,
protected ?CacheItemPoolInterface $cache = null
) {
$this->cacheKey = 'mcp_tools_' . md5($this->name);
}
/**
* Create a new MCP connection for a given Streamable HTTP endpoint
*
* @param string $endpoint
* @param array<string, string> $headers
* @return self
*/
public static function forStreamableHttp(string $endpoint, array $headers = []): self
{
$client = Client::withStreamableHttp(
endpoint: $endpoint,
headers: $headers,
);
$connection = new self($client, 'MCP server');
$connection->withCacheKey('mcp_tools_' . md5($endpoint));
return $connection;
}
/**
* Create a new MCP connection for a given SSE endpoint
*
* @param string $endpoint
* @param array<string, string> $headers
* @return self
*/
public static function forSse(string $endpoint, array $headers = []): self
{
$client = Client::withSse(
endpoint: $endpoint,
headers: $headers,
);
$connection = new self($client, 'MCP server');
$connection->withCacheKey('mcp_tools_' . md5($endpoint));
return $connection;
}
/**
* Create a new MCP connection for a given process command
*
* @param string $processCommand The command to start the process
* @param int $autoRestartAmount Amount of times to allow auto-restart the process when the process terminates unexpectedly
* @return array{0: self, 1: resource}
*/
public static function forProcess(string $processCommand, int $autoRestartAmount = 0): array
{
[$client, $process] = Client::withProcess(
command: $processCommand,
autoRestartAmount: $autoRestartAmount
);
$connection = new self($client, 'MCP server');
$connection->withCacheKey('mcp_tools_' . md5($processCommand));
return [$connection, $process];
}
/**
* Only allow specific tools to be used from this MCP connection.
*
* @param string ...$toolNames List of tool names to allow
* @return $this
*/
public function withTools(string ...$toolNames): self
{
$this->allowedToolNames = array_merge($this->allowedToolNames, $toolNames);
return $this;
}
/**
* Get the connection name
*
* @return string
*/
public function getName(): string
{
return $this->name;
}
/**
* Get the MCP client
*
* @return Client
*/
public function getClient(): Client
{
return $this->client;
}
/**
* Set a PSR-6 cache implementation
*
* @param CacheItemPoolInterface $cache PSR-6 cache implementation
* @return $this
*/
public function withCache(CacheItemPoolInterface $cache): self
{
$this->cache = $cache;
return $this;
}
/**
* Set the cache key
*
* @param string $cacheKey The cache key to use for storing tools
* @return $this
*/
public function withCacheKey(string $cacheKey): self
{
$this->cacheKey = $cacheKey;
return $this;
}
/**
* Set the cache TTL (time to live)
*
* @param int $cacheTtl Cache lifetime in seconds
* @return $this
*/
public function withCacheTtl(int $cacheTtl): self
{
$this->cacheTtl = $cacheTtl;
return $this;
}
/**
* Sets the metadata that will be sent with each MCP request
*
* @param array<string, mixed>|Closure $meta The metadata
* @return $this
*/
public function withMeta(array|Closure $meta): self
{
$this->meta = $meta;
return $this;
}
/**
* Connect to the MCP server
*/
public function connect(): void
{
if ($this->client->isConnected()) {
return;
}
$this->client->connect();
}
/**
* List all tools available from this MCP connection
*
* @param bool $refresh Whether to refresh the cached tools
* @return array<McpTool> Array of Tools
*/
public function listTools(bool $refresh = false): array
{
// Use in-memory cache if available and not refreshing
if (! $refresh && $this->hasInMemoryCache()) {
return $this->tools ?? [];
}
// Try to get tools from persistent cache if available and not refreshing
if (! $refresh && $this->hasPersistentCache()) {
$cachedTools = $this->getToolsFromCache();
if ($cachedTools !== null) {
$this->tools = $cachedTools;
return $this->tools;
}
}
// Fetch tools from MCP server
$this->tools = $this->fetchTools();
// Store in persistent cache if available
if ($this->hasPersistentCache()) {
$this->storeToolsInCache($this->tools);
}
return $this->tools ?? [];
}
/**
* Check if tools are cached in memory
*
* @return bool
*/
protected function hasInMemoryCache(): bool
{
return isset($this->tools);
}
/**
* Check if persistent cache is available
*
* @return bool
*/
protected function hasPersistentCache(): bool
{
return $this->cache !== null;
}
/**
* Get tools from persistent cache
*
* @return array<McpTool>|null Array of Tools or null if not found
*/
protected function getToolsFromCache(): ?array
{
if ($this->cache === null) {
return null;
}
$cacheItem = $this->cache->getItem($this->cacheKey);
if ($cacheItem->isHit()) {
$cachedTools = $cacheItem->get();
if (! is_array($cachedTools)) {
return null;
}
/** @var array<McpTool> $cachedTools */
return $cachedTools;
}
return null;
}
/**
* Store tools in persistent cache
*
* @param array<McpTool> $tools Array of Tools to cache
* @return void
*/
protected function storeToolsInCache(array $tools): void
{
if ($this->cache === null) {
return;
}
$cacheItem = $this->cache->getItem($this->cacheKey);
$cacheItem->set($tools);
$cacheItem->expiresAfter($this->cacheTtl);
$this->cache->save($cacheItem);
}
/**
* Execute the tool
*
* Calls the MCP tool with the provided arguments
*
* @return string The result of the tool call
* @throws HandleToolException if the tool call fails
*/
public function callTool(Tool $tool): string
{
assert($tool instanceof McpTool);
try {
$request = new CallToolRequest(
name: $tool->name(),
arguments: $tool->getDynamicPropertyValues()
);
$this->addMetadata($request);
$result = $this->client->callTool($request);
if ($result instanceof JsonRpcError) {
throw new HandleToolException($result->getMessage());
}
// Extract text content from the result
return $this->extractTextContent($result);
} catch (Throwable $e) {
throw new HandleToolException("Failed to call MCP tool: {$e->getMessage()}", 0, $e);
}
}
/**
* Extract text content from a CallToolResult
*
* @param CallToolResult $result The call tool result
* @return string The extracted text content
*/
protected function extractTextContent(CallToolResult $result): string
{
$content = '';
foreach ($result->getContent() as $item) {
if ($item instanceof TextContent) {
$content .= $item->getText();
}
}
return $content;
}
/**
* Fetches the tools from the MCP server
*
* @return array<McpTool>
*/
protected function fetchTools(): array
{
$request = new ListToolsRequest();
$this->addMetadata($request);
$response = $this->client->listTools($request);
if ($response instanceof JsonRpcError) {
throw new \RuntimeException("Error fetching tools: {$response->getMessage()}");
}
$tools = $response->getTools();
if (! empty($this->allowedToolNames)) {
$tools = array_filter($tools, fn ($tool) => in_array($tool->getName(), $this->allowedToolNames));
}
return McpToolFactory::createTools($this, $tools);
}
/**
* Evaluate metadata and add to request
*
* @param BaseRequest $request
* @return void
*/
protected function addMetadata(BaseRequest $request): void
{
if ($this->meta instanceof Closure) {
$metadata = ($this->meta)($request);
} else {
$metadata = $this->meta;
}
$request->withMeta($metadata);
}
/**
* Disconnect from the MCP server
*/
public function disconnect(): void
{
$this->client->disconnect();
}
}