FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-sdk/src/mcp/types.py at main · PawitRoy/python-sdk · GitHub
PawitRoy
/
python-sdk
Public
forked from
modelcontextprotocol/python-sdk
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
python-sdk
/
src
/
mcp
/
types.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
1130 lines (812 loc) · 33 KB
Breadcrumbs
python-sdk
/
src
/
mcp
/
types.py
Copy path
File metadata and controls
1130 lines (812 loc) · 33 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
from
collections
.
abc
import
Callable
from
typing
import
(
Annotated
,
Any
,
Generic
,
Literal
,
TypeAlias
,
TypeVar
,
)
from
pydantic
import
BaseModel
,
ConfigDict
,
Field
,
FileUrl
,
RootModel
from
pydantic
.
networks
import
AnyUrl
,
UrlConstraints
"""
Model Context Protocol bindings for Python
These bindings were generated from https://github.com/modelcontextprotocol/specification,
using Claude, with a prompt something like the following:
Generate idiomatic Python bindings for this schema for MCP, or the "Model Context
Protocol." The schema is defined in TypeScript, but there's also a JSON Schema version
for reference.
* For the bindings, let's use Pydantic V2 models.
* Each model should allow extra fields everywhere, by specifying `model_config =
ConfigDict(extra='allow')`. Do this in every case, instead of a custom base class.
* Union types should be represented with a Pydantic `RootModel`.
* Define additional model classes instead of using dictionaries. Do this even if they're
not separate types in the schema.
"""
LATEST_PROTOCOL_VERSION
=
"2024-11-05"
ProgressToken
=
str
|
int
Cursor
=
str
Role
=
Literal
[
"user"
,
"assistant"
]
RequestId
=
str
|
int
AnyFunction
:
TypeAlias
=
Callable
[...,
Any
]
class
RequestParams
(
BaseModel
):
class
Meta
(
BaseModel
):
progressToken
:
ProgressToken
|
None
=
None
"""
If specified, the caller requests 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.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
meta
:
Meta
|
None
=
Field
(
alias
=
"_meta"
,
default
=
None
)
class
NotificationParams
(
BaseModel
):
class
Meta
(
BaseModel
):
model_config
=
ConfigDict
(
extra
=
"allow"
)
meta
:
Meta
|
None
=
Field
(
alias
=
"_meta"
,
default
=
None
)
"""
This parameter name is reserved by MCP to allow clients and servers to attach
additional metadata to their notifications.
"""
RequestParamsT
=
TypeVar
(
"RequestParamsT"
,
bound
=
RequestParams
|
dict
[
str
,
Any
]
|
None
)
NotificationParamsT
=
TypeVar
(
"NotificationParamsT"
,
bound
=
NotificationParams
|
dict
[
str
,
Any
]
|
None
)
MethodT
=
TypeVar
(
"MethodT"
,
bound
=
str
)
class
Request
(
BaseModel
,
Generic
[
RequestParamsT
,
MethodT
]):
"""Base class for JSON-RPC requests."""
method
:
MethodT
params
:
RequestParamsT
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
PaginatedRequest
(
Request
[
RequestParamsT
,
MethodT
]):
cursor
:
Cursor
|
None
=
None
"""
An opaque token representing the current pagination position.
If provided, the server should return results starting after this cursor.
"""
class
Notification
(
BaseModel
,
Generic
[
NotificationParamsT
,
MethodT
]):
"""Base class for JSON-RPC notifications."""
method
:
MethodT
params
:
NotificationParamsT
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
Result
(
BaseModel
):
"""Base class for JSON-RPC results."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
meta
:
dict
[
str
,
Any
]
|
None
=
Field
(
alias
=
"_meta"
,
default
=
None
)
"""
This result property is reserved by the protocol to allow clients and servers to
attach additional metadata to their responses.
"""
class
PaginatedResult
(
Result
):
nextCursor
:
Cursor
|
None
=
None
"""
An opaque token representing the pagination position after the last returned result.
If present, there may be more results available.
"""
class
JSONRPCRequest
(
Request
[
dict
[
str
,
Any
]
|
None
,
str
]):
"""A request that expects a response."""
jsonrpc
:
Literal
[
"2.0"
]
id
:
RequestId
method
:
str
params
:
dict
[
str
,
Any
]
|
None
=
None
class
JSONRPCNotification
(
Notification
[
dict
[
str
,
Any
]
|
None
,
str
]):
"""A notification which does not expect a response."""
jsonrpc
:
Literal
[
"2.0"
]
params
:
dict
[
str
,
Any
]
|
None
=
None
class
JSONRPCResponse
(
BaseModel
):
"""A successful (non-error) response to a request."""
jsonrpc
:
Literal
[
"2.0"
]
id
:
RequestId
result
:
dict
[
str
,
Any
]
model_config
=
ConfigDict
(
extra
=
"allow"
)
# Standard JSON-RPC error codes
PARSE_ERROR
=
-
32700
INVALID_REQUEST
=
-
32600
METHOD_NOT_FOUND
=
-
32601
INVALID_PARAMS
=
-
32602
INTERNAL_ERROR
=
-
32603
class
ErrorData
(
BaseModel
):
"""Error information for JSON-RPC error responses."""
code
:
int
"""The error type that occurred."""
message
:
str
"""
A short description of the error. The message SHOULD be limited to a concise single
sentence.
"""
data
:
Any
|
None
=
None
"""
Additional information about the error. The value of this member is defined by the
sender (e.g. detailed error information, nested errors etc.).
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
JSONRPCError
(
BaseModel
):
"""A response to a request that indicates an error occurred."""
jsonrpc
:
Literal
[
"2.0"
]
id
:
str
|
int
error
:
ErrorData
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
JSONRPCMessage
(
RootModel
[
JSONRPCRequest
|
JSONRPCNotification
|
JSONRPCResponse
|
JSONRPCError
]
):
pass
class
EmptyResult
(
Result
):
"""A response that indicates success but carries no data."""
class
Implementation
(
BaseModel
):
"""Describes the name and version of an MCP implementation."""
name
:
str
version
:
str
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
RootsCapability
(
BaseModel
):
"""Capability for root operations."""
listChanged
:
bool
|
None
=
None
"""Whether the client supports notifications for changes to the roots list."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
SamplingCapability
(
BaseModel
):
"""Capability for logging operations."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ClientCapabilities
(
BaseModel
):
"""Capabilities a client may support."""
experimental
:
dict
[
str
,
dict
[
str
,
Any
]]
|
None
=
None
"""Experimental, non-standard capabilities that the client supports."""
sampling
:
SamplingCapability
|
None
=
None
"""Present if the client supports sampling from an LLM."""
roots
:
RootsCapability
|
None
=
None
"""Present if the client supports listing roots."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
PromptsCapability
(
BaseModel
):
"""Capability for prompts operations."""
listChanged
:
bool
|
None
=
None
"""Whether this server supports notifications for changes to the prompt list."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ResourcesCapability
(
BaseModel
):
"""Capability for resources operations."""
subscribe
:
bool
|
None
=
None
"""Whether this server supports subscribing to resource updates."""
listChanged
:
bool
|
None
=
None
"""Whether this server supports notifications for changes to the resource list."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ToolsCapability
(
BaseModel
):
"""Capability for tools operations."""
listChanged
:
bool
|
None
=
None
"""Whether this server supports notifications for changes to the tool list."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
LoggingCapability
(
BaseModel
):
"""Capability for logging operations."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ServerCapabilities
(
BaseModel
):
"""Capabilities that a server may support."""
experimental
:
dict
[
str
,
dict
[
str
,
Any
]]
|
None
=
None
"""Experimental, non-standard capabilities that the server supports."""
logging
:
LoggingCapability
|
None
=
None
"""Present if the server supports sending log messages to the client."""
prompts
:
PromptsCapability
|
None
=
None
"""Present if the server offers any prompt templates."""
resources
:
ResourcesCapability
|
None
=
None
"""Present if the server offers any resources to read."""
tools
:
ToolsCapability
|
None
=
None
"""Present if the server offers any tools to call."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
InitializeRequestParams
(
RequestParams
):
"""Parameters for the initialize request."""
protocolVersion
:
str
|
int
"""The latest version of the Model Context Protocol that the client supports."""
capabilities
:
ClientCapabilities
clientInfo
:
Implementation
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
InitializeRequest
(
Request
[
InitializeRequestParams
,
Literal
[
"initialize"
]]):
"""
This request is sent from the client to the server when it first connects, asking it
to begin initialization.
"""
method
:
Literal
[
"initialize"
]
params
:
InitializeRequestParams
class
InitializeResult
(
Result
):
"""After receiving an initialize request from the client, the server sends this."""
protocolVersion
:
str
|
int
"""The version of the Model Context Protocol that the server wants to use."""
capabilities
:
ServerCapabilities
serverInfo
:
Implementation
instructions
:
str
|
None
=
None
"""Instructions describing how to use the server and its features."""
class
InitializedNotification
(
Notification
[
NotificationParams
|
None
,
Literal
[
"notifications/initialized"
]]
):
"""
This notification is sent from the client to the server after initialization has
finished.
"""
method
:
Literal
[
"notifications/initialized"
]
params
:
NotificationParams
|
None
=
None
class
PingRequest
(
Request
[
RequestParams
|
None
,
Literal
[
"ping"
]]):
"""
A ping, issued by either the server or the client, to check that the other party is
still alive.
"""
method
:
Literal
[
"ping"
]
params
:
RequestParams
|
None
=
None
class
ProgressNotificationParams
(
NotificationParams
):
"""Parameters for progress notifications."""
progressToken
:
ProgressToken
"""
The progress token which was given in the initial request, used to associate this
notification with the request that is proceeding.
"""
progress
:
float
"""
The progress thus far. This should increase every time progress is made, even if the
total is unknown.
"""
total
:
float
|
None
=
None
"""Total number of items to process (or total progress required), if known."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ProgressNotification
(
Notification
[
ProgressNotificationParams
,
Literal
[
"notifications/progress"
]]
):
"""
An out-of-band notification used to inform the receiver of a progress update for a
long-running request.
"""
method
:
Literal
[
"notifications/progress"
]
params
:
ProgressNotificationParams
class
ListResourcesRequest
(
PaginatedRequest
[
RequestParams
|
None
,
Literal
[
"resources/list"
]]
):
"""Sent from the client to request a list of resources the server has."""
method
:
Literal
[
"resources/list"
]
params
:
RequestParams
|
None
=
None
class
Annotations
(
BaseModel
):
audience
:
list
[
Role
]
|
None
=
None
priority
:
Annotated
[
float
,
Field
(
ge
=
0.0
,
le
=
1.0
)]
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
Resource
(
BaseModel
):
"""A known resource that the server is capable of reading."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""The URI of this resource."""
name
:
str
"""A human-readable name for this resource."""
description
:
str
|
None
=
None
"""A description of what this resource represents."""
mimeType
:
str
|
None
=
None
"""The MIME type of this resource, if known."""
size
:
int
|
None
=
None
"""
The size of the raw resource content, in bytes (i.e., before base64 encoding
or any tokenization), if known.
This can be used by Hosts to display file sizes and estimate context window usage.
"""
annotations
:
Annotations
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ResourceTemplate
(
BaseModel
):
"""A template description for resources available on the server."""
uriTemplate
:
str
"""
A URI template (according to RFC 6570) that can be used to construct resource
URIs.
"""
name
:
str
"""A human-readable name for the type of resource this template refers to."""
description
:
str
|
None
=
None
"""A human-readable description of what this template is for."""
mimeType
:
str
|
None
=
None
"""
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.
"""
annotations
:
Annotations
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ListResourcesResult
(
PaginatedResult
):
"""The server's response to a resources/list request from the client."""
resources
:
list
[
Resource
]
class
ListResourceTemplatesRequest
(
PaginatedRequest
[
RequestParams
|
None
,
Literal
[
"resources/templates/list"
]]
):
"""Sent from the client to request a list of resource templates the server has."""
method
:
Literal
[
"resources/templates/list"
]
params
:
RequestParams
|
None
=
None
class
ListResourceTemplatesResult
(
PaginatedResult
):
"""The server's response to a resources/templates/list request from the client."""
resourceTemplates
:
list
[
ResourceTemplate
]
class
ReadResourceRequestParams
(
RequestParams
):
"""Parameters for reading a resource."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""
The URI of the resource to read. The URI can use any protocol; it is up to the
server how to interpret it.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ReadResourceRequest
(
Request
[
ReadResourceRequestParams
,
Literal
[
"resources/read"
]]
):
"""Sent from the client to the server, to read a specific resource URI."""
method
:
Literal
[
"resources/read"
]
params
:
ReadResourceRequestParams
class
ResourceContents
(
BaseModel
):
"""The contents of a specific resource or sub-resource."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""The URI of this resource."""
mimeType
:
str
|
None
=
None
"""The MIME type of this resource, if known."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
TextResourceContents
(
ResourceContents
):
"""Text contents of a resource."""
text
:
str
"""
The text of the item. This must only be set if the item can actually be represented
as text (not binary data).
"""
class
BlobResourceContents
(
ResourceContents
):
"""Binary contents of a resource."""
blob
:
str
"""A base64-encoded string representing the binary data of the item."""
class
ReadResourceResult
(
Result
):
"""The server's response to a resources/read request from the client."""
contents
:
list
[
TextResourceContents
|
BlobResourceContents
]
class
ResourceListChangedNotification
(
Notification
[
NotificationParams
|
None
,
Literal
[
"notifications/resources/list_changed"
]
]
):
"""
An optional notification from the server to the client, informing it that the list
of resources it can read from has changed.
"""
method
:
Literal
[
"notifications/resources/list_changed"
]
params
:
NotificationParams
|
None
=
None
class
SubscribeRequestParams
(
RequestParams
):
"""Parameters for subscribing to a resource."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""
The URI of the resource to subscribe to. The URI can use any protocol; it is up to
the server how to interpret it.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
SubscribeRequest
(
Request
[
SubscribeRequestParams
,
Literal
[
"resources/subscribe"
]]):
"""
Sent from the client to request resources/updated notifications from the server
whenever a particular resource changes.
"""
method
:
Literal
[
"resources/subscribe"
]
params
:
SubscribeRequestParams
class
UnsubscribeRequestParams
(
RequestParams
):
"""Parameters for unsubscribing from a resource."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""The URI of the resource to unsubscribe from."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
UnsubscribeRequest
(
Request
[
UnsubscribeRequestParams
,
Literal
[
"resources/unsubscribe"
]]
):
"""
Sent from the client to request cancellation of resources/updated notifications from
the server.
"""
method
:
Literal
[
"resources/unsubscribe"
]
params
:
UnsubscribeRequestParams
class
ResourceUpdatedNotificationParams
(
NotificationParams
):
"""Parameters for resource update notifications."""
uri
:
Annotated
[
AnyUrl
,
UrlConstraints
(
host_required
=
False
)]
"""
The URI of the resource that has been updated. This might be a sub-resource of the
one that the client actually subscribed to.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ResourceUpdatedNotification
(
Notification
[
ResourceUpdatedNotificationParams
,
Literal
[
"notifications/resources/updated"
]
]
):
"""
A notification from the server to the client, informing it that a resource has
changed and may need to be read again.
"""
method
:
Literal
[
"notifications/resources/updated"
]
params
:
ResourceUpdatedNotificationParams
class
ListPromptsRequest
(
PaginatedRequest
[
RequestParams
|
None
,
Literal
[
"prompts/list"
]]
):
"""Sent from the client to request a list of prompts and prompt templates."""
method
:
Literal
[
"prompts/list"
]
params
:
RequestParams
|
None
=
None
class
PromptArgument
(
BaseModel
):
"""An argument for a prompt template."""
name
:
str
"""The name of the argument."""
description
:
str
|
None
=
None
"""A human-readable description of the argument."""
required
:
bool
|
None
=
None
"""Whether this argument must be provided."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
Prompt
(
BaseModel
):
"""A prompt or prompt template that the server offers."""
name
:
str
"""The name of the prompt or prompt template."""
description
:
str
|
None
=
None
"""An optional description of what this prompt provides."""
arguments
:
list
[
PromptArgument
]
|
None
=
None
"""A list of arguments to use for templating the prompt."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ListPromptsResult
(
PaginatedResult
):
"""The server's response to a prompts/list request from the client."""
prompts
:
list
[
Prompt
]
class
GetPromptRequestParams
(
RequestParams
):
"""Parameters for getting a prompt."""
name
:
str
"""The name of the prompt or prompt template."""
arguments
:
dict
[
str
,
str
]
|
None
=
None
"""Arguments to use for templating the prompt."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
GetPromptRequest
(
Request
[
GetPromptRequestParams
,
Literal
[
"prompts/get"
]]):
"""Used by the client to get a prompt provided by the server."""
method
:
Literal
[
"prompts/get"
]
params
:
GetPromptRequestParams
class
TextContent
(
BaseModel
):
"""Text content for a message."""
type
:
Literal
[
"text"
]
text
:
str
"""The text content of the message."""
annotations
:
Annotations
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ImageContent
(
BaseModel
):
"""Image content for a message."""
type
:
Literal
[
"image"
]
data
:
str
"""The base64-encoded image data."""
mimeType
:
str
"""
The MIME type of the image. Different providers may support different
image types.
"""
annotations
:
Annotations
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
SamplingMessage
(
BaseModel
):
"""Describes a message issued to or received from an LLM API."""
role
:
Role
content
:
TextContent
|
ImageContent
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
EmbeddedResource
(
BaseModel
):
"""
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.
"""
type
:
Literal
[
"resource"
]
resource
:
TextResourceContents
|
BlobResourceContents
annotations
:
Annotations
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
PromptMessage
(
BaseModel
):
"""Describes a message returned as part of a prompt."""
role
:
Role
content
:
TextContent
|
ImageContent
|
EmbeddedResource
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
GetPromptResult
(
Result
):
"""The server's response to a prompts/get request from the client."""
description
:
str
|
None
=
None
"""An optional description for the prompt."""
messages
:
list
[
PromptMessage
]
class
PromptListChangedNotification
(
Notification
[
NotificationParams
|
None
,
Literal
[
"notifications/prompts/list_changed"
]
]
):
"""
An optional notification from the server to the client, informing it that the list
of prompts it offers has changed.
"""
method
:
Literal
[
"notifications/prompts/list_changed"
]
params
:
NotificationParams
|
None
=
None
class
ListToolsRequest
(
PaginatedRequest
[
RequestParams
|
None
,
Literal
[
"tools/list"
]]):
"""Sent from the client to request a list of tools the server has."""
method
:
Literal
[
"tools/list"
]
params
:
RequestParams
|
None
=
None
class
Tool
(
BaseModel
):
"""Definition for a tool the client can call."""
name
:
str
"""The name of the tool."""
description
:
str
|
None
=
None
"""A human-readable description of the tool."""
inputSchema
:
dict
[
str
,
Any
]
"""A JSON Schema object defining the expected parameters for the tool."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ListToolsResult
(
PaginatedResult
):
"""The server's response to a tools/list request from the client."""
tools
:
list
[
Tool
]
class
CallToolRequestParams
(
RequestParams
):
"""Parameters for calling a tool."""
name
:
str
arguments
:
dict
[
str
,
Any
]
|
None
=
None
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CallToolRequest
(
Request
[
CallToolRequestParams
,
Literal
[
"tools/call"
]]):
"""Used by the client to invoke a tool provided by the server."""
method
:
Literal
[
"tools/call"
]
params
:
CallToolRequestParams
class
CallToolResult
(
Result
):
"""The server's response to a tool call."""
content
:
list
[
TextContent
|
ImageContent
|
EmbeddedResource
]
isError
:
bool
=
False
class
ToolListChangedNotification
(
Notification
[
NotificationParams
|
None
,
Literal
[
"notifications/tools/list_changed"
]]
):
"""
An optional notification from the server to the client, informing it that the list
of tools it offers has changed.
"""
method
:
Literal
[
"notifications/tools/list_changed"
]
params
:
NotificationParams
|
None
=
None
LoggingLevel
=
Literal
[
"debug"
,
"info"
,
"notice"
,
"warning"
,
"error"
,
"critical"
,
"alert"
,
"emergency"
]
class
SetLevelRequestParams
(
RequestParams
):
"""Parameters for setting the logging level."""
level
:
LoggingLevel
"""The level of logging that the client wants to receive from the server."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
SetLevelRequest
(
Request
[
SetLevelRequestParams
,
Literal
[
"logging/setLevel"
]]):
"""A request from the client to the server, to enable or adjust logging."""
method
:
Literal
[
"logging/setLevel"
]
params
:
SetLevelRequestParams
class
LoggingMessageNotificationParams
(
NotificationParams
):
"""Parameters for logging message notifications."""
level
:
LoggingLevel
"""The severity of this log message."""
logger
:
str
|
None
=
None
"""An optional name of the logger issuing this message."""
data
:
Any
"""
The data to be logged, such as a string message or an object. Any JSON serializable
type is allowed here.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
LoggingMessageNotification
(
Notification
[
LoggingMessageNotificationParams
,
Literal
[
"notifications/message"
]]
):
"""Notification of a log message passed from server to client."""
method
:
Literal
[
"notifications/message"
]
params
:
LoggingMessageNotificationParams
IncludeContext
=
Literal
[
"none"
,
"thisServer"
,
"allServers"
]
class
ModelHint
(
BaseModel
):
"""Hints to use for model selection."""
name
:
str
|
None
=
None
"""A hint for a model name."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
ModelPreferences
(
BaseModel
):
"""
The server's preferences for model selection, requested by 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.
"""
hints
:
list
[
ModelHint
]
|
None
=
None
"""
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.
"""
costPriority
:
float
|
None
=
None
"""
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.
"""
speedPriority
:
float
|
None
=
None
"""
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.
"""
intelligencePriority
:
float
|
None
=
None
"""
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.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CreateMessageRequestParams
(
RequestParams
):
"""Parameters for creating a message."""
messages
:
list
[
SamplingMessage
]
modelPreferences
:
ModelPreferences
|
None
=
None
"""
The server's preferences for which model to select. The client MAY ignore
these preferences.
"""
systemPrompt
:
str
|
None
=
None
"""An optional system prompt the server wants to use for sampling."""
includeContext
:
IncludeContext
|
None
=
None
"""
A request to include context from one or more MCP servers (including the caller), to
be attached to the prompt.
"""
temperature
:
float
|
None
=
None
maxTokens
:
int
"""The maximum number of tokens to sample, as requested by the server."""
stopSequences
:
list
[
str
]
|
None
=
None
metadata
:
dict
[
str
,
Any
]
|
None
=
None
"""Optional metadata to pass through to the LLM provider."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CreateMessageRequest
(
Request
[
CreateMessageRequestParams
,
Literal
[
"sampling/createMessage"
]]
):
"""A request from the server to sample an LLM via the client."""
method
:
Literal
[
"sampling/createMessage"
]
params
:
CreateMessageRequestParams
StopReason
=
Literal
[
"endTurn"
,
"stopSequence"
,
"maxTokens"
]
|
str
class
CreateMessageResult
(
Result
):
"""The client's response to a sampling/create_message request from the server."""
role
:
Role
content
:
TextContent
|
ImageContent
model
:
str
"""The name of the model that generated the message."""
stopReason
:
StopReason
|
None
=
None
"""The reason why sampling stopped, if known."""
class
ResourceReference
(
BaseModel
):
"""A reference to a resource or resource template definition."""
type
:
Literal
[
"ref/resource"
]
uri
:
str
"""The URI or URI template of the resource."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
PromptReference
(
BaseModel
):
"""Identifies a prompt."""
type
:
Literal
[
"ref/prompt"
]
name
:
str
"""The name of the prompt or prompt template"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CompletionArgument
(
BaseModel
):
"""The argument's information for completion requests."""
name
:
str
"""The name of the argument"""
value
:
str
"""The value of the argument to use for completion matching."""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CompleteRequestParams
(
RequestParams
):
"""Parameters for completion requests."""
ref
:
ResourceReference
|
PromptReference
argument
:
CompletionArgument
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CompleteRequest
(
Request
[
CompleteRequestParams
,
Literal
[
"completion/complete"
]]):
"""A request from the client to the server, to ask for completion options."""
method
:
Literal
[
"completion/complete"
]
params
:
CompleteRequestParams
class
Completion
(
BaseModel
):
"""Completion information."""
values
:
list
[
str
]
"""An array of completion values. Must not exceed 100 items."""
total
:
int
|
None
=
None
"""
The total number of completion options available. This can exceed the number of
values actually sent in the response.
"""
hasMore
:
bool
|
None
=
None
"""
Indicates whether there are additional completion options beyond those provided in
the current response, even if the exact total is unknown.
"""
model_config
=
ConfigDict
(
extra
=
"allow"
)
class
CompleteResult
(
Result
):
"""The server's response to a completion/complete request"""
completion
:
Completion
class
ListRootsRequest
(
Request
[
RequestParams
|
None
,
Literal
[
"roots/list"
]]):
"""
Sent from the server to request a list of root URIs from the client. Roots allow
servers to ask for specific directories or files to operate on. A common example
for roots is providing a set of repositories or directories a server should operate
on.
This request is typically used when the server needs to understand the file system
structure or access specific locations that the client has permission to read from.
"""
method
:
Literal
[
"roots/list"
]
params
:
RequestParams
|
None
=
None
class
Root
(
BaseModel
):
"""Represents a root directory or file that the server can operate on."""
uri
:
FileUrl
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL