Skip to content

Commit 2e119aa

Browse files
authored
Merge pull request #639 from modelcontextprotocol/basil/_meta_language
update _meta usage guidance in `types.ts`
2 parents bbc128c + 784d944 commit 2e119aa

File tree

1 file changed

+33
-21
lines changed

1 file changed

+33
-21
lines changed

src/types.ts

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ export const RequestSchema = z.object({
4444
const BaseNotificationParamsSchema = z
4545
.object({
4646
/**
47-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
48-
*/
47+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
48+
* for notes on _meta usage.
49+
*/
4950
_meta: z.optional(z.object({}).passthrough()),
5051
})
5152
.passthrough();
@@ -58,8 +59,9 @@ export const NotificationSchema = z.object({
5859
export const ResultSchema = z
5960
.object({
6061
/**
61-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
62-
*/
62+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
63+
* for notes on _meta usage.
64+
*/
6365
_meta: z.optional(z.object({}).passthrough()),
6466
})
6567
.passthrough();
@@ -440,7 +442,8 @@ export const ResourceContentsSchema = z
440442
*/
441443
mimeType: z.optional(z.string()),
442444
/**
443-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
445+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
446+
* for notes on _meta usage.
444447
*/
445448
_meta: z.optional(z.object({}).passthrough()),
446449
})
@@ -482,8 +485,9 @@ export const ResourceSchema = BaseMetadataSchema.extend({
482485
mimeType: z.optional(z.string()),
483486

484487
/**
485-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
486-
*/
488+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
489+
* for notes on _meta usage.
490+
*/
487491
_meta: z.optional(z.object({}).passthrough()),
488492
});
489493

@@ -509,8 +513,9 @@ export const ResourceTemplateSchema = BaseMetadataSchema.extend({
509513
mimeType: z.optional(z.string()),
510514

511515
/**
512-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
513-
*/
516+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
517+
* for notes on _meta usage.
518+
*/
514519
_meta: z.optional(z.object({}).passthrough()),
515520
});
516521

@@ -646,7 +651,8 @@ export const PromptSchema = BaseMetadataSchema.extend({
646651
*/
647652
arguments: z.optional(z.array(PromptArgumentSchema)),
648653
/**
649-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
654+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
655+
* for notes on _meta usage.
650656
*/
651657
_meta: z.optional(z.object({}).passthrough()),
652658
});
@@ -694,8 +700,9 @@ export const TextContentSchema = z
694700
text: z.string(),
695701

696702
/**
697-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
698-
*/
703+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
704+
* for notes on _meta usage.
705+
*/
699706
_meta: z.optional(z.object({}).passthrough()),
700707
})
701708
.passthrough();
@@ -716,8 +723,9 @@ export const ImageContentSchema = z
716723
mimeType: z.string(),
717724

718725
/**
719-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
720-
*/
726+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
727+
* for notes on _meta usage.
728+
*/
721729
_meta: z.optional(z.object({}).passthrough()),
722730
})
723731
.passthrough();
@@ -738,8 +746,9 @@ export const AudioContentSchema = z
738746
mimeType: z.string(),
739747

740748
/**
741-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
742-
*/
749+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
750+
* for notes on _meta usage.
751+
*/
743752
_meta: z.optional(z.object({}).passthrough()),
744753
})
745754
.passthrough();
@@ -752,7 +761,8 @@ export const EmbeddedResourceSchema = z
752761
type: z.literal("resource"),
753762
resource: z.union([TextResourceContentsSchema, BlobResourceContentsSchema]),
754763
/**
755-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
764+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
765+
* for notes on _meta usage.
756766
*/
757767
_meta: z.optional(z.object({}).passthrough()),
758768
})
@@ -899,8 +909,9 @@ export const ToolSchema = BaseMetadataSchema.extend({
899909
annotations: z.optional(ToolAnnotationsSchema),
900910

901911
/**
902-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
903-
*/
912+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
913+
* for notes on _meta usage.
914+
*/
904915
_meta: z.optional(z.object({}).passthrough()),
905916
});
906917

@@ -1335,8 +1346,9 @@ export const RootSchema = z
13351346
name: z.optional(z.string()),
13361347

13371348
/**
1338-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
1339-
*/
1349+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
1350+
* for notes on _meta usage.
1351+
*/
13401352
_meta: z.optional(z.object({}).passthrough()),
13411353
})
13421354
.passthrough();

0 commit comments

Comments
 (0)