Skip to content

Commit 784d944

Browse files
committed
update _meta comments
1 parent 61ef3c9 commit 784d944

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();
@@ -436,7 +438,8 @@ export const ResourceContentsSchema = z
436438
*/
437439
mimeType: z.optional(z.string()),
438440
/**
439-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
441+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
442+
* for notes on _meta usage.
440443
*/
441444
_meta: z.optional(z.object({}).passthrough()),
442445
})
@@ -478,8 +481,9 @@ export const ResourceSchema = BaseMetadataSchema.extend({
478481
mimeType: z.optional(z.string()),
479482

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

@@ -505,8 +509,9 @@ export const ResourceTemplateSchema = BaseMetadataSchema.extend({
505509
mimeType: z.optional(z.string()),
506510

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

@@ -642,7 +647,8 @@ export const PromptSchema = BaseMetadataSchema.extend({
642647
*/
643648
arguments: z.optional(z.array(PromptArgumentSchema)),
644649
/**
645-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
650+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
651+
* for notes on _meta usage.
646652
*/
647653
_meta: z.optional(z.object({}).passthrough()),
648654
});
@@ -690,8 +696,9 @@ export const TextContentSchema = z
690696
text: z.string(),
691697

692698
/**
693-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
694-
*/
699+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
700+
* for notes on _meta usage.
701+
*/
695702
_meta: z.optional(z.object({}).passthrough()),
696703
})
697704
.passthrough();
@@ -712,8 +719,9 @@ export const ImageContentSchema = z
712719
mimeType: z.string(),
713720

714721
/**
715-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
716-
*/
722+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
723+
* for notes on _meta usage.
724+
*/
717725
_meta: z.optional(z.object({}).passthrough()),
718726
})
719727
.passthrough();
@@ -734,8 +742,9 @@ export const AudioContentSchema = z
734742
mimeType: z.string(),
735743

736744
/**
737-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
738-
*/
745+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
746+
* for notes on _meta usage.
747+
*/
739748
_meta: z.optional(z.object({}).passthrough()),
740749
})
741750
.passthrough();
@@ -748,7 +757,8 @@ export const EmbeddedResourceSchema = z
748757
type: z.literal("resource"),
749758
resource: z.union([TextResourceContentsSchema, BlobResourceContentsSchema]),
750759
/**
751-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
760+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
761+
* for notes on _meta usage.
752762
*/
753763
_meta: z.optional(z.object({}).passthrough()),
754764
})
@@ -895,8 +905,9 @@ export const ToolSchema = BaseMetadataSchema.extend({
895905
annotations: z.optional(ToolAnnotationsSchema),
896906

897907
/**
898-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
899-
*/
908+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
909+
* for notes on _meta usage.
910+
*/
900911
_meta: z.optional(z.object({}).passthrough()),
901912
});
902913

@@ -1230,8 +1241,9 @@ export const RootSchema = z
12301241
name: z.optional(z.string()),
12311242

12321243
/**
1233-
* Reserved by MCP for protocol-level metadata; implementations must not make assumptions about its contents.
1234-
*/
1244+
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
1245+
* for notes on _meta usage.
1246+
*/
12351247
_meta: z.optional(z.object({}).passthrough()),
12361248
})
12371249
.passthrough();

0 commit comments

Comments
 (0)