forked from modelcontextprotocol/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.ts
1113 lines (1021 loc) · 30.2 KB
/
schema.ts
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* JSON-RPC types */
export type JSONRPCMessage =
| JSONRPCRequest
| JSONRPCNotification
| JSONRPCResponse
| JSONRPCError;
export const LATEST_PROTOCOL_VERSION = "2024-11-05";
export const JSONRPC_VERSION = "2.0";
/**
* A progress token, used to associate progress notifications with the original request.
*/
export type ProgressToken = string | number;
/**
* An opaque token used to represent a cursor for pagination.
*/
export type Cursor = string;
export interface Request {
method: string;
params?: {
_meta?: {
/**
* If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
*/
progressToken?: ProgressToken;
};
[key: string]: unknown;
};
}
export interface Notification {
method: string;
params?: {
/**
* This parameter name is reserved by MCP to allow clients and servers to attach additional metadata to their notifications.
*/
_meta?: { [key: string]: unknown };
[key: string]: unknown;
};
}
export interface Result {
/**
* This result property is reserved by the protocol to allow clients and servers to attach additional metadata to their responses.
*/
_meta?: { [key: string]: unknown };
[key: string]: unknown;
}
/**
* A uniquely identifying ID for a request in JSON-RPC.
*/
export type RequestId = string | number;
/**
* A request that expects a response.
*/
export interface JSONRPCRequest extends Request {
jsonrpc: typeof JSONRPC_VERSION;
id: RequestId;
}
/**
* A notification which does not expect a response.
*/
export interface JSONRPCNotification extends Notification {
jsonrpc: typeof JSONRPC_VERSION;
}
/**
* A successful (non-error) response to a request.
*/
export interface JSONRPCResponse {
jsonrpc: typeof JSONRPC_VERSION;
id: RequestId;
result: Result;
}
// Standard JSON-RPC error codes
export const PARSE_ERROR = -32700;
export const INVALID_REQUEST = -32600;
export const METHOD_NOT_FOUND = -32601;
export const INVALID_PARAMS = -32602;
export const INTERNAL_ERROR = -32603;
/**
* A response to a request that indicates an error occurred.
*/
export interface JSONRPCError {
jsonrpc: typeof JSONRPC_VERSION;
id: RequestId;
error: {
/**
* The error type that occurred.
*/
code: number;
/**
* A short description of the error. The message SHOULD be limited to a concise single sentence.
*/
message: string;
/**
* Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).
*/
data?: unknown;
};
}
/* Empty result */
/**
* A response that indicates success but carries no data.
*/
export type EmptyResult = Result;
/* Cancellation */
/**
* This notification can be sent by either side to indicate that it is cancelling a previously-issued request.
*
* The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.
*
* This notification indicates that the result will be unused, so any associated processing SHOULD cease.
*
* A client MUST NOT attempt to cancel its `initialize` request.
*/
export interface CancelledNotification extends Notification {
method: "notifications/cancelled";
params: {
/**
* The ID of the request to cancel.
*
* This MUST correspond to the ID of a request previously issued in the same direction.
*/
requestId: RequestId;
/**
* An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.
*/
reason?: string;
};
}
/* Initialization */
/**
* This request is sent from the client to the server when it first connects, asking it to begin initialization.
*/
export interface InitializeRequest extends Request {
method: "initialize";
params: {
/**
* The latest version of the Model Context Protocol that the client supports. The client MAY decide to support older versions as well.
*/
protocolVersion: string;
capabilities: ClientCapabilities;
clientInfo: Implementation;
};
}
/**
* After receiving an initialize request from the client, the server sends this response.
*/
export interface InitializeResult extends Result {
/**
* The version of the Model Context Protocol that the server wants to use. This may not match the version that the client requested. If the client cannot support this version, it MUST disconnect.
*/
protocolVersion: string;
capabilities: ServerCapabilities;
serverInfo: Implementation;
/**
* Instructions describing how to use the server and its features.
*
* This can be used by clients to improve the LLM's understanding of available tools, resources, etc. It can be thought of like a "hint" to the model. For example, this information MAY be added to the system prompt.
*/
instructions?: string;
}
/**
* This notification is sent from the client to the server after initialization has finished.
*/
export interface InitializedNotification extends Notification {
method: "notifications/initialized";
}
/**
* Capabilities a client may support. Known capabilities are defined here, in this schema, but this is not a closed set: any client can define its own, additional capabilities.
*/
export interface ClientCapabilities {
/**
* Experimental, non-standard capabilities that the client supports.
*/
experimental?: { [key: string]: object };
/**
* Present if the client supports listing roots.
*/
roots?: {
/**
* Whether the client supports notifications for changes to the roots list.
*/
listChanged?: boolean;
};
/**
* Present if the client supports sampling from an LLM.
*/
sampling?: object;
}
/**
* Capabilities that a server may support. Known capabilities are defined here, in this schema, but this is not a closed set: any server can define its own, additional capabilities.
*/
export interface ServerCapabilities {
/**
* Experimental, non-standard capabilities that the server supports.
*/
experimental?: { [key: string]: object };
/**
* Present if the server supports sending log messages to the client.
*/
logging?: object;
/**
* Present if the server offers any prompt templates.
*/
prompts?: {
/**
* Whether this server supports notifications for changes to the prompt list.
*/
listChanged?: boolean;
};
/**
* Present if the server offers any resources to read.
*/
resources?: {
/**
* Whether this server supports subscribing to resource updates.
*/
subscribe?: boolean;
/**
* Whether this server supports notifications for changes to the resource list.
*/
listChanged?: boolean;
};
/**
* Present if the server offers any tools to call.
*/
tools?: {
/**
* Whether this server supports notifications for changes to the tool list.
*/
listChanged?: boolean;
};
}
/**
* Describes the name and version of an MCP implementation.
*/
export interface Implementation {
name: string;
version: string;
}
/* Ping */
/**
* A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.
*/
export interface PingRequest extends Request {
method: "ping";
}
/* Progress notifications */
/**
* An out-of-band notification used to inform the receiver of a progress update for a long-running request.
*/
export interface ProgressNotification extends Notification {
method: "notifications/progress";
params: {
/**
* The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.
*/
progressToken: ProgressToken;
/**
* The progress thus far. This should increase every time progress is made, even if the total is unknown.
*
* @TJS-type number
*/
progress: number;
/**
* Total number of items to process (or total progress required), if known.
*
* @TJS-type number
*/
total?: number;
};
}
/* Pagination */
export interface PaginatedRequest extends Request {
params?: {
/**
* An opaque token representing the current pagination position.
* If provided, the server should return results starting after this cursor.
*/
cursor?: Cursor;
};
}
export interface PaginatedResult extends Result {
/**
* An opaque token representing the pagination position after the last returned result.
* If present, there may be more results available.
*/
nextCursor?: Cursor;
}
/* Resources */
/**
* Sent from the client to request a list of resources the server has.
*/
export interface ListResourcesRequest extends PaginatedRequest {
method: "resources/list";
}
/**
* The server's response to a resources/list request from the client.
*/
export interface ListResourcesResult extends PaginatedResult {
resources: Resource[];
}
/**
* Sent from the client to request a list of resource templates the server has.
*/
export interface ListResourceTemplatesRequest extends PaginatedRequest {
method: "resources/templates/list";
}
/**
* The server's response to a resources/templates/list request from the client.
*/
export interface ListResourceTemplatesResult extends PaginatedResult {
resourceTemplates: ResourceTemplate[];
}
/**
* Sent from the client to the server, to read a specific resource URI.
*/
export interface ReadResourceRequest extends Request {
method: "resources/read";
params: {
/**
* The URI of the resource to read. The URI can use any protocol; it is up to the server how to interpret it.
*
* @format uri
*/
uri: string;
};
}
/**
* The server's response to a resources/read request from the client.
*/
export interface ReadResourceResult extends Result {
contents: (TextResourceContents | BlobResourceContents)[];
}
/**
* An optional notification from the server to the client, informing it that the list of resources it can read from has changed. This may be issued by servers without any previous subscription from the client.
*/
export interface ResourceListChangedNotification extends Notification {
method: "notifications/resources/list_changed";
}
/**
* Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.
*/
export interface SubscribeRequest extends Request {
method: "resources/subscribe";
params: {
/**
* The URI of the resource to subscribe to. The URI can use any protocol; it is up to the server how to interpret it.
*
* @format uri
*/
uri: string;
};
}
/**
* Sent from the client to request cancellation of resources/updated notifications from the server. This should follow a previous resources/subscribe request.
*/
export interface UnsubscribeRequest extends Request {
method: "resources/unsubscribe";
params: {
/**
* The URI of the resource to unsubscribe from.
*
* @format uri
*/
uri: string;
};
}
/**
* A notification from the server to the client, informing it that a resource has changed and may need to be read again. This should only be sent if the client previously sent a resources/subscribe request.
*/
export interface ResourceUpdatedNotification extends Notification {
method: "notifications/resources/updated";
params: {
/**
* The URI of the resource that has been updated. This might be a sub-resource of the one that the client actually subscribed to.
*
* @format uri
*/
uri: string;
};
}
/**
* A known resource that the server is capable of reading.
*/
export interface Resource extends Annotated {
/**
* The URI of this resource.
*
* @format uri
*/
uri: string;
/**
* A human-readable name for this resource.
*
* This can be used by clients to populate UI elements.
*/
name: string;
/**
* A description of what this resource represents.
*
* This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
*/
description?: string;
/**
* The MIME type of this resource, if known.
*/
mimeType?: string;
}
/**
* A template description for resources available on the server.
*/
export interface ResourceTemplate extends Annotated {
/**
* A URI template (according to RFC 6570) that can be used to construct resource URIs.
*
* @format uri-template
*/
uriTemplate: string;
/**
* A human-readable name for the type of resource this template refers to.
*
* This can be used by clients to populate UI elements.
*/
name: string;
/**
* A description of what this template is for.
*
* This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
*/
description?: string;
/**
* The MIME type for all resources that match this template. This should only be included if all resources matching this template have the same type.
*/
mimeType?: string;
}
/**
* The contents of a specific resource or sub-resource.
*/
export interface ResourceContents {
/**
* The URI of this resource.
*
* @format uri
*/
uri: string;
/**
* The MIME type of this resource, if known.
*/
mimeType?: string;
}
export interface TextResourceContents extends ResourceContents {
/**
* The text of the item. This must only be set if the item can actually be represented as text (not binary data).
*/
text: string;
}
export interface BlobResourceContents extends ResourceContents {
/**
* A base64-encoded string representing the binary data of the item.
*
* @format byte
*/
blob: string;
}
/* Prompts */
/**
* Sent from the client to request a list of prompts and prompt templates the server has.
*/
export interface ListPromptsRequest extends PaginatedRequest {
method: "prompts/list";
}
/**
* The server's response to a prompts/list request from the client.
*/
export interface ListPromptsResult extends PaginatedResult {
prompts: Prompt[];
}
/**
* Used by the client to get a prompt provided by the server.
*/
export interface GetPromptRequest extends Request {
method: "prompts/get";
params: {
/**
* The name of the prompt or prompt template.
*/
name: string;
/**
* Arguments to use for templating the prompt.
*/
arguments?: { [key: string]: string };
};
}
/**
* The server's response to a prompts/get request from the client.
*/
export interface GetPromptResult extends Result {
/**
* An optional description for the prompt.
*/
description?: string;
messages: PromptMessage[];
}
/**
* A prompt or prompt template that the server offers.
*/
export interface Prompt {
/**
* The name of the prompt or prompt template.
*/
name: string;
/**
* An optional description of what this prompt provides
*/
description?: string;
/**
* A list of arguments to use for templating the prompt.
*/
arguments?: PromptArgument[];
}
/**
* Describes an argument that a prompt can accept.
*/
export interface PromptArgument {
/**
* The name of the argument.
*/
name: string;
/**
* A human-readable description of the argument.
*/
description?: string;
/**
* Whether this argument must be provided.
*/
required?: boolean;
}
/**
* The sender or recipient of messages and data in a conversation.
*/
export type Role = "user" | "assistant";
/**
* Describes a message returned as part of a prompt.
*
* This is similar to `SamplingMessage`, but also supports the embedding of
* resources from the MCP server.
*/
export interface PromptMessage {
role: Role;
content: TextContent | ImageContent | EmbeddedResource;
}
/**
* The contents of a resource, embedded into a prompt or tool call result.
*
* It is up to the client how best to render embedded resources for the benefit
* of the LLM and/or the user.
*/
export interface EmbeddedResource extends Annotated {
type: "resource";
resource: TextResourceContents | BlobResourceContents;
}
/**
* An optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.
*/
export interface PromptListChangedNotification extends Notification {
method: "notifications/prompts/list_changed";
}
/* Tools */
/**
* Sent from the client to request a list of tools the server has.
*/
export interface ListToolsRequest extends PaginatedRequest {
method: "tools/list";
}
/**
* The server's response to a tools/list request from the client.
*/
export interface ListToolsResult extends PaginatedResult {
tools: Tool[];
}
/**
* The server's response to a tool call.
*
* Any errors that originate from the tool SHOULD be reported inside the result
* object, with `isError` set to true, _not_ as an MCP protocol-level error
* response. Otherwise, the LLM would not be able to see that an error occurred
* and self-correct.
*
* However, any errors in _finding_ the tool, an error indicating that the
* server does not support tool calls, or any other exceptional conditions,
* should be reported as an MCP error response.
*/
export interface CallToolResult extends Result {
content: (TextContent | ImageContent | EmbeddedResource)[];
/**
* Whether the tool call ended in an error.
*
* If not set, this is assumed to be false (the call was successful).
*/
isError?: boolean;
}
/**
* Used by the client to invoke a tool provided by the server.
*/
export interface CallToolRequest extends Request {
method: "tools/call";
params: {
name: string;
arguments?: { [key: string]: unknown };
};
}
/**
* An optional notification from the server to the client, informing it that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.
*/
export interface ToolListChangedNotification extends Notification {
method: "notifications/tools/list_changed";
}
/**
* Definition for a tool the client can call.
*/
export interface Tool {
/**
* The name of the tool.
*/
name: string;
/**
* A human-readable description of the tool.
*/
description?: string;
/**
* A JSON Schema object defining the expected parameters for the tool.
*/
inputSchema: {
type: "object";
properties?: { [key: string]: object };
required?: string[];
};
}
/* Logging */
/**
* A request from the client to the server, to enable or adjust logging.
*/
export interface SetLevelRequest extends Request {
method: "logging/setLevel";
params: {
/**
* The level of logging that the client wants to receive from the server. The server should send all logs at this level and higher (i.e., more severe) to the client as notifications/logging/message.
*/
level: LoggingLevel;
};
}
/**
* Notification of a log message passed from server to client. If no logging/setLevel request has been sent from the client, the server MAY decide which messages to send automatically.
*/
export interface LoggingMessageNotification extends Notification {
method: "notifications/message";
params: {
/**
* The severity of this log message.
*/
level: LoggingLevel;
/**
* An optional name of the logger issuing this message.
*/
logger?: string;
/**
* The data to be logged, such as a string message or an object. Any JSON serializable type is allowed here.
*/
data: unknown;
};
}
/**
* The severity of a log message.
*
* These map to syslog message severities, as specified in RFC-5424:
* https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1
*/
export type LoggingLevel =
| "debug"
| "info"
| "notice"
| "warning"
| "error"
| "critical"
| "alert"
| "emergency";
/* Sampling */
/**
* A request from the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.
*/
export interface CreateMessageRequest extends Request {
method: "sampling/createMessage";
params: {
messages: SamplingMessage[];
/**
* The server's preferences for which model to select. The client MAY ignore these preferences.
*/
modelPreferences?: ModelPreferences;
/**
* An optional system prompt the server wants to use for sampling. The client MAY modify or omit this prompt.
*/
systemPrompt?: string;
/**
* A request to include context from one or more MCP servers (including the caller), to be attached to the prompt. The client MAY ignore this request.
*/
includeContext?: "none" | "thisServer" | "allServers";
/**
* @TJS-type number
*/
temperature?: number;
/**
* The maximum number of tokens to sample, as requested by the server. The client MAY choose to sample fewer tokens than requested.
*/
maxTokens: number;
stopSequences?: string[];
/**
* Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.
*/
metadata?: object;
};
}
/**
* The client's response to a sampling/create_message request from the server. The client should inform the user before returning the sampled message, to allow them to inspect the response (human in the loop) and decide whether to allow the server to see it.
*/
export interface CreateMessageResult extends Result, SamplingMessage {
/**
* The name of the model that generated the message.
*/
model: string;
/**
* The reason why sampling stopped, if known.
*/
stopReason?: "endTurn" | "stopSequence" | "maxTokens" | string;
}
/**
* Describes a message issued to or received from an LLM API.
*/
export interface SamplingMessage {
role: Role;
content: TextContent | ImageContent;
}
/**
* Base for objects that include optional annotations for the client. The client can use annotations to inform how objects are used or displayed
*/
export interface Annotated {
annotations?: {
/**
* Describes who the intended customer of this object or data is.
*
* It can include multiple entries to indicate content useful for multiple audiences (e.g., `["user", "assistant"]`).
*/
audience?: Role[];
/**
* Describes how important this data is for operating the server.
*
* A value of 1 means "most important," and indicates that the data is
* effectively required, while 0 means "least important," and indicates that
* the data is entirely optional.
*
* @TJS-type number
* @minimum 0
* @maximum 1
*/
priority?: number;
}
}
/**
* Text provided to or from an LLM.
*/
export interface TextContent extends Annotated {
type: "text";
/**
* The text content of the message.
*/
text: string;
}
/**
* An image provided to or from an LLM.
*/
export interface ImageContent extends Annotated {
type: "image";
/**
* The base64-encoded image data.
*
* @format byte
*/
data: string;
/**
* The MIME type of the image. Different providers may support different image types.
*/
mimeType: string;
}
/**
* The server's preferences for model selection, requested of the client during sampling.
*
* Because LLMs can vary along multiple dimensions, choosing the "best" model is
* rarely straightforward. Different models excel in different areas—some are
* faster but less capable, others are more capable but more expensive, and so
* on. This interface allows servers to express their priorities across multiple
* dimensions to help clients make an appropriate selection for their use case.
*
* These preferences are always advisory. The client MAY ignore them. It is also
* up to the client to decide how to interpret these preferences and how to
* balance them against other considerations.
*/
export interface ModelPreferences {
/**
* Optional hints to use for model selection.
*
* If multiple hints are specified, the client MUST evaluate them in order
* (such that the first match is taken).
*
* The client SHOULD prioritize these hints over the numeric priorities, but
* MAY still use the priorities to select from ambiguous matches.
*/
hints?: ModelHint[];
/**
* How much to prioritize cost when selecting a model. A value of 0 means cost
* is not important, while a value of 1 means cost is the most important
* factor.
*
* @TJS-type number
* @minimum 0
* @maximum 1
*/
costPriority?: number;
/**
* How much to prioritize sampling speed (latency) when selecting a model. A
* value of 0 means speed is not important, while a value of 1 means speed is
* the most important factor.
*
* @TJS-type number
* @minimum 0
* @maximum 1
*/
speedPriority?: number;
/**
* How much to prioritize intelligence and capabilities when selecting a
* model. A value of 0 means intelligence is not important, while a value of 1
* means intelligence is the most important factor.
*
* @TJS-type number
* @minimum 0
* @maximum 1
*/
intelligencePriority?: number;
}
/**
* Hints to use for model selection.
*
* Keys not declared here are currently left unspecified by the spec and are up
* to the client to interpret.
*/
export interface ModelHint {
/**
* A hint for a model name.
*
* The client SHOULD treat this as a substring of a model name; for example:
* - `claude-3-5-sonnet` should match `claude-3-5-sonnet-20241022`
* - `sonnet` should match `claude-3-5-sonnet-20241022`, `claude-3-sonnet-20240229`, etc.
* - `claude` should match any Claude model
*
* The client MAY also map the string to a different provider's model name or a different model family, as long as it fills a similar niche; for example:
* - `gemini-1.5-flash` could match `claude-3-haiku-20240307`
*/
name?: string;
}
/* Autocomplete */
/**
* A request from the client to the server, to ask for completion options.
*/
export interface CompleteRequest extends Request {
method: "completion/complete";
params: {
ref: PromptReference | ResourceReference;
/**
* The argument's information
*/
argument: {
/**
* The name of the argument
*/
name: string;
/**
* The value of the argument to use for completion matching.
*/
value: string;
};
};
}
/**
* The server's response to a completion/complete request
*/
export interface CompleteResult extends Result {
completion: {
/**
* An array of completion values. Must not exceed 100 items.
*/
values: string[];
/**
* The total number of completion options available. This can exceed the number of values actually sent in the response.
*/
total?: number;
/**
* Indicates whether there are additional completion options beyond those provided in the current response, even if the exact total is unknown.
*/
hasMore?: boolean;
};
}
/**
* A reference to a resource or resource template definition.
*/
export interface ResourceReference {
type: "ref/resource";
/**
* The URI or URI template of the resource.
*
* @format uri-template
*/
uri: string;