-
Notifications
You must be signed in to change notification settings - Fork 141
Expand file tree
/
Copy pathClient.php
More file actions
284 lines (239 loc) · 8.85 KB
/
Client.php
File metadata and controls
284 lines (239 loc) · 8.85 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
<?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;
use Mcp\Client\Builder;
use Mcp\Client\Configuration;
use Mcp\Client\Protocol;
use Mcp\Client\Transport\TransportInterface;
use Mcp\Exception\ConnectionException;
use Mcp\Exception\RequestException;
use Mcp\Schema\Enum\LoggingLevel;
use Mcp\Schema\Implementation;
use Mcp\Schema\JsonRpc\Error;
use Mcp\Schema\JsonRpc\Request;
use Mcp\Schema\JsonRpc\Response;
use Mcp\Schema\PromptReference;
use Mcp\Schema\Request\CallToolRequest;
use Mcp\Schema\Request\CompletionCompleteRequest;
use Mcp\Schema\Request\GetPromptRequest;
use Mcp\Schema\Request\ListPromptsRequest;
use Mcp\Schema\Request\ListResourcesRequest;
use Mcp\Schema\Request\ListResourceTemplatesRequest;
use Mcp\Schema\Request\ListToolsRequest;
use Mcp\Schema\Request\PingRequest;
use Mcp\Schema\Request\ReadResourceRequest;
use Mcp\Schema\Request\SetLogLevelRequest;
use Mcp\Schema\ResourceReference;
use Mcp\Schema\Result\CallToolResult;
use Mcp\Schema\Result\CompletionCompleteResult;
use Mcp\Schema\Result\GetPromptResult;
use Mcp\Schema\Result\ListPromptsResult;
use Mcp\Schema\Result\ListResourcesResult;
use Mcp\Schema\Result\ListResourceTemplatesResult;
use Mcp\Schema\Result\ListToolsResult;
use Mcp\Schema\Result\ReadResourceResult;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* Main MCP Client facade.
*
* Provides a synchronous API for communicating with MCP servers.
* All blocking operations are delegated to the transport.
*
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
*/
class Client
{
private ?TransportInterface $transport = null;
public function __construct(
private readonly Protocol $protocol,
private readonly Configuration $config,
private readonly LoggerInterface $logger = new NullLogger(),
) {
}
/**
* Create a new client builder for fluent configuration.
*/
public static function builder(): Builder
{
return new Builder();
}
/**
* Connect to an MCP server using the provided transport.
*
* @throws ConnectionException If connection or initialization fails
*/
public function connect(TransportInterface $transport): void
{
$this->transport = $transport;
$this->protocol->connect($transport, $this->config);
$transport->connect();
$this->logger->info('Client connected and initialized');
}
/**
* Check if connected and initialized.
*/
public function isConnected(): bool
{
return null !== $this->transport && $this->protocol->getState()->isInitialized();
}
/**
* Get server information from initialization.
*/
public function getServerInfo(): ?Implementation
{
return $this->protocol->getState()->getServerInfo();
}
/**
* Get server instructions.
*/
public function getInstructions(): ?string
{
return $this->protocol->getState()->getInstructions();
}
/**
* Send a ping request to the server.
*/
public function ping(): void
{
$request = new PingRequest();
$this->sendRequest($request);
}
/**
* List available tools from the server.
*/
public function listTools(?string $cursor = null): ListToolsResult
{
$request = new ListToolsRequest($cursor);
$response = $this->sendRequest($request);
return ListToolsResult::fromArray($response->result);
}
/**
* Call a tool on the server.
*
* @param string $name Tool name
* @param array<string, mixed> $arguments Tool arguments
* @param (callable(float $progress, ?float $total, ?string $message): void)|null $onProgress
* Optional callback for progress updates
*/
public function callTool(string $name, array $arguments = [], ?callable $onProgress = null): CallToolResult
{
$request = new CallToolRequest($name, $arguments);
$response = $this->sendRequest($request, $onProgress);
return CallToolResult::fromArray($response->result);
}
/**
* List available resources from the server.
*/
public function listResources(?string $cursor = null): ListResourcesResult
{
$request = new ListResourcesRequest($cursor);
$response = $this->sendRequest($request);
return ListResourcesResult::fromArray($response->result);
}
/**
* List available resource templates from the server.
*/
public function listResourceTemplates(?string $cursor = null): ListResourceTemplatesResult
{
$request = new ListResourceTemplatesRequest($cursor);
$response = $this->sendRequest($request);
return ListResourceTemplatesResult::fromArray($response->result);
}
/**
* Read a resource by URI.
*
* @param string $uri The resource URI
* @param (callable(float $progress, ?float $total, ?string $message): void)|null $onProgress
* Optional callback for progress updates
*/
public function readResource(string $uri, ?callable $onProgress = null): ReadResourceResult
{
$request = new ReadResourceRequest($uri);
$response = $this->sendRequest($request, $onProgress);
return ReadResourceResult::fromArray($response->result);
}
/**
* List available prompts from the server.
*/
public function listPrompts(?string $cursor = null): ListPromptsResult
{
$request = new ListPromptsRequest($cursor);
$response = $this->sendRequest($request);
return ListPromptsResult::fromArray($response->result);
}
/**
* Get a prompt from the server.
*
* @param string $name Prompt name
* @param array<string, string> $arguments Prompt arguments
* @param (callable(float $progress, ?float $total, ?string $message): void)|null $onProgress
* Optional callback for progress updates
*/
public function getPrompt(string $name, array $arguments = [], ?callable $onProgress = null): GetPromptResult
{
$request = new GetPromptRequest($name, $arguments);
$response = $this->sendRequest($request, $onProgress);
return GetPromptResult::fromArray($response->result);
}
/**
* Request completion suggestions for a prompt or resource argument.
*
* @param PromptReference|ResourceReference $ref The prompt or resource reference
* @param array{name: string, value: string} $argument The argument to complete
*/
public function complete(PromptReference|ResourceReference $ref, array $argument): CompletionCompleteResult
{
$request = new CompletionCompleteRequest($ref, $argument);
$response = $this->sendRequest($request);
return CompletionCompleteResult::fromArray($response->result);
}
/**
* Set the minimum logging level for server log messages.
*/
public function setLoggingLevel(LoggingLevel $level): void
{
$request = new SetLogLevelRequest($level);
$this->sendRequest($request);
}
/**
* Send a request to the server and wait for response.
*
* @param (callable(float $progress, ?float $total, ?string $message): void)|null $onProgress
*
* @return Response<mixed>
*
* @throws RequestException|ConnectionException
*/
private function sendRequest(Request $request, ?callable $onProgress = null): Response
{
if (!$this->isConnected()) {
throw new ConnectionException('Client is not connected. Call connect() first.');
}
$withProgress = null !== $onProgress;
$fiber = new \Fiber(fn () => $this->protocol->request($request, $this->config->requestTimeout, $withProgress));
$response = $this->transport->runRequest($fiber, $onProgress);
if ($response instanceof Error) {
throw RequestException::fromError($response);
}
return $response;
}
/**
* Disconnect from the server.
*/
public function disconnect(): void
{
if (null !== $this->transport) {
$this->transport->close();
$this->transport = null;
$this->logger->info('Client disconnected');
}
}
}