mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-18 00:03:23 +02:00
[WIP] Refactor everything server to be more modular and use recommended APIs.
* Updated architecture.md
* Refactor/renamed resources/dynamic.ts to resources/template.ts
- refactor/renamed registerDynamicResources to registerResourceTemplates
- this highlights the more salient fact that we are demonstrating registration of resource templates in this example.
- exposed the ability to dynamically create the text resources from elsewhere (namely the resource-prompt example
* Added prompts/resource.ts
- in registerEmbeddedResourcePrompt()
- register a prompt that takes a resourceId and returns the prompt with the corresponding dynamically created resource embedded
This commit is contained in:
@@ -30,10 +30,11 @@ src/everything
|
|||||||
│ ├── index.ts
|
│ ├── index.ts
|
||||||
│ ├── simple.ts
|
│ ├── simple.ts
|
||||||
│ ├── complex.ts
|
│ ├── complex.ts
|
||||||
│ └── completions.ts
|
│ ├── completions.ts
|
||||||
|
│ └── resource.ts
|
||||||
├── resources
|
├── resources
|
||||||
│ ├── index.ts
|
│ ├── index.ts
|
||||||
│ ├── dynamic.ts
|
│ ├── template.ts
|
||||||
│ └── static.ts
|
│ └── static.ts
|
||||||
├── docs
|
├── docs
|
||||||
│ ├── server-instructions.md
|
│ ├── server-instructions.md
|
||||||
@@ -87,16 +88,19 @@ At `src/everything`:
|
|||||||
- Registers `complex-prompt`: a prompt with two arguments (`city` required, `state` optional) used to compose a message.
|
- Registers `complex-prompt`: a prompt with two arguments (`city` required, `state` optional) used to compose a message.
|
||||||
- completions.ts
|
- completions.ts
|
||||||
- Registers `completable-prompt`: a prompt whose arguments support server-driven completions using the SDK’s `completable(...)` helper (e.g., completing `department` and context-aware `name`).
|
- Registers `completable-prompt`: a prompt whose arguments support server-driven completions using the SDK’s `completable(...)` helper (e.g., completing `department` and context-aware `name`).
|
||||||
|
- resource.ts
|
||||||
|
- Exposes `registerEmbeddedResourcePrompt(server)` which registers `resource-prompt` — a prompt that accepts `resourceId` and embeds a dynamically generated text resource within the returned messages. Internally reuses helpers from `resources/template.ts`.
|
||||||
|
|
||||||
- resources/
|
- resources/
|
||||||
|
|
||||||
- index.ts
|
- index.ts
|
||||||
- `registerResources(server)` orchestrator; delegates to static and dynamic resources.
|
- `registerResources(server)` orchestrator; delegates to template‑based dynamic resources and static resources by calling `registerResourceTemplates(server)` and `registerStaticResources(server)`.
|
||||||
- dynamic.ts
|
- template.ts
|
||||||
- Registers two dynamic, template‑driven resources using `ResourceTemplate`:
|
- Registers two dynamic, template‑driven resources using `ResourceTemplate`:
|
||||||
- Text: `demo://resource/dynamic/text/{index}` (MIME: `text/plain`)
|
- Text: `demo://resource/dynamic/text/{index}` (MIME: `text/plain`)
|
||||||
- Blob: `demo://resource/dynamic/blob/{index}` (MIME: `application/octet-stream`, Base64 payload)
|
- Blob: `demo://resource/dynamic/blob/{index}` (MIME: `application/octet-stream`, Base64 payload)
|
||||||
- The `{index}` path variable must be a finite integer. Content is generated on demand with a GMT timestamp.
|
- The `{index}` path variable must be a finite integer. Content is generated on demand with a timestamp.
|
||||||
|
- Exposes helpers `textResource(uri, index)` and `textResourceUri(index)` so other modules can construct and embed text resources directly (e.g., from prompts).
|
||||||
- static.ts
|
- static.ts
|
||||||
- Registers static resources for each file in the `docs/` folder.
|
- Registers static resources for each file in the `docs/` folder.
|
||||||
- URIs follow the pattern: `demo://static/docs/<filename>`.
|
- URIs follow the pattern: `demo://static/docs/<filename>`.
|
||||||
@@ -157,6 +161,7 @@ At `src/everything`:
|
|||||||
- `simple-prompt` (prompts/simple.ts): No-argument prompt that returns a static user message.
|
- `simple-prompt` (prompts/simple.ts): No-argument prompt that returns a static user message.
|
||||||
- `complex-prompt` (prompts/complex.ts): Two-argument prompt with `city` (required) and `state` (optional) used to compose a question.
|
- `complex-prompt` (prompts/complex.ts): Two-argument prompt with `city` (required) and `state` (optional) used to compose a question.
|
||||||
- `completable-prompt` (prompts/completions.ts): Demonstrates argument auto-completions with the SDK’s `completable` helper; `department` completions drive context-aware `name` suggestions.
|
- `completable-prompt` (prompts/completions.ts): Demonstrates argument auto-completions with the SDK’s `completable` helper; `department` completions drive context-aware `name` suggestions.
|
||||||
|
- `resource-prompt` (prompts/resource.ts): Accepts `resourceId` (string convertible to integer) and returns messages that include an embedded dynamic text resource generated via `resources/template.ts`.
|
||||||
|
|
||||||
- Resources
|
- Resources
|
||||||
- Dynamic Text: `demo://resource/dynamic/text/{index}` (content generated on the fly)
|
- Dynamic Text: `demo://resource/dynamic/text/{index}` (content generated on the fly)
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|||||||
import { registerSimplePrompt } from "./simple.js";
|
import { registerSimplePrompt } from "./simple.js";
|
||||||
import { registerComplexPrompt } from "./complex.js";
|
import { registerComplexPrompt } from "./complex.js";
|
||||||
import { registerPromptWithCompletions } from "./completions.js";
|
import { registerPromptWithCompletions } from "./completions.js";
|
||||||
|
import { registerEmbeddedResourcePrompt } from "./resource.js"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register the prompts with the MCP server.
|
* Register the prompts with the MCP server.
|
||||||
@@ -11,4 +12,5 @@ export const registerPrompts = (server: McpServer) => {
|
|||||||
registerSimplePrompt(server);
|
registerSimplePrompt(server);
|
||||||
registerComplexPrompt(server);
|
registerComplexPrompt(server);
|
||||||
registerPromptWithCompletions(server);
|
registerPromptWithCompletions(server);
|
||||||
|
registerEmbeddedResourcePrompt(server);
|
||||||
};
|
};
|
||||||
|
|||||||
51
src/everything/prompts/resource.ts
Normal file
51
src/everything/prompts/resource.ts
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||||
|
import {textResource, textResourceUri} from "../resources/template.js";
|
||||||
|
|
||||||
|
export const registerEmbeddedResourcePrompt = (server: McpServer) => {
|
||||||
|
// NOTE: Currently, prompt arguments can only be strings since type is not field of PromptArgument
|
||||||
|
// Consequently, we must define it as a string and convert the argument to number before using it
|
||||||
|
// https://modelcontextprotocol.io/specification/2025-11-25/schema#promptargument
|
||||||
|
const promptArgsSchema = {
|
||||||
|
resourceId: z.string().describe("ID of the text resource to fetch"),
|
||||||
|
};
|
||||||
|
|
||||||
|
server.registerPrompt(
|
||||||
|
"resource-prompt",
|
||||||
|
{
|
||||||
|
title: "Resource Prompt",
|
||||||
|
description: "A prompt that includes an embedded resource reference",
|
||||||
|
argsSchema: promptArgsSchema,
|
||||||
|
},
|
||||||
|
(args) => {
|
||||||
|
const resourceId = Number(args?.resourceId); // Inspector sends strings only
|
||||||
|
if (!Number.isFinite(resourceId) || !Number.isInteger(resourceId)) {
|
||||||
|
throw new Error(
|
||||||
|
`Invalid resourceId: ${args?.resourceId}. Must be a finite integer.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const uri = textResourceUri(resourceId);
|
||||||
|
const resource = textResource(uri, resourceId);
|
||||||
|
|
||||||
|
return {
|
||||||
|
messages: [
|
||||||
|
{
|
||||||
|
role: "user",
|
||||||
|
content: {
|
||||||
|
type: "text",
|
||||||
|
text: `This prompt includes the text resource with id: ${resourceId}. Please analyze the following resource:`,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
role: "user",
|
||||||
|
content: {
|
||||||
|
type: "resource",
|
||||||
|
resource: resource,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
|
};
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||||
import { registerDynamicResources } from "./dynamic.js";
|
import { registerResourceTemplates } from "./template.js";
|
||||||
import { registerStaticResources } from "./static.js";
|
import { registerStaticResources } from "./static.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -7,6 +7,6 @@ import { registerStaticResources } from "./static.js";
|
|||||||
* @param server
|
* @param server
|
||||||
*/
|
*/
|
||||||
export const registerResources = (server: McpServer) => {
|
export const registerResources = (server: McpServer) => {
|
||||||
registerDynamicResources(server);
|
registerResourceTemplates(server);
|
||||||
registerStaticResources(server);
|
registerStaticResources(server);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -3,8 +3,52 @@ import {
|
|||||||
ResourceTemplate,
|
ResourceTemplate,
|
||||||
} from "@modelcontextprotocol/sdk/server/mcp.js";
|
} from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||||
|
|
||||||
|
const uriBase: string = "demo://resource/dynamic";
|
||||||
|
const textUriBase: string = `${uriBase}/text`;
|
||||||
|
const blobUriBase: string = `${uriBase}/blob`;
|
||||||
|
const textUriTemplate: string = `${textUriBase}/{index}`;
|
||||||
|
const blobUriTemplate: string = `${blobUriBase}/{index}`;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register dynamic resources with the MCP server.
|
* Create a dynamic text resource
|
||||||
|
* @param uri
|
||||||
|
* @param index
|
||||||
|
*/
|
||||||
|
export const textResource = (uri: URL, index: number) => {
|
||||||
|
const timestamp = new Date().toLocaleTimeString();
|
||||||
|
return {
|
||||||
|
uri: uri.toString(),
|
||||||
|
mimeType: "text/plain",
|
||||||
|
text: `Resource ${index}: This is a plaintext resource created at ${timestamp}`,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a dynamic blob resource
|
||||||
|
* @param uri
|
||||||
|
* @param index
|
||||||
|
*/
|
||||||
|
export const blobResource = (uri: URL, index: number) => {
|
||||||
|
const timestamp = new Date().toLocaleTimeString();
|
||||||
|
const resourceText = Buffer.from(
|
||||||
|
`Resource ${index}: This is a base64 blob created at ${timestamp}`
|
||||||
|
).toString("base64");
|
||||||
|
return {
|
||||||
|
uri: uri.toString(),
|
||||||
|
mimeType: "text/plain",
|
||||||
|
text: resourceText,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a dynamic text resource URI
|
||||||
|
* @param index
|
||||||
|
*/
|
||||||
|
export const textResourceUri = (index: number) =>
|
||||||
|
new URL(`${textUriBase}/${index}`);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register resource templates with the MCP server.
|
||||||
*
|
*
|
||||||
* - Text and blob resources, dynamically generated from the URI {index} variable
|
* - Text and blob resources, dynamically generated from the URI {index} variable
|
||||||
* - Any finite integer is acceptable for the index variable
|
* - Any finite integer is acceptable for the index variable
|
||||||
@@ -18,41 +62,7 @@ import {
|
|||||||
*
|
*
|
||||||
* @param server
|
* @param server
|
||||||
*/
|
*/
|
||||||
export const registerDynamicResources = (server: McpServer) => {
|
export const registerResourceTemplates = (server: McpServer) => {
|
||||||
const uriBase: string = "demo://resource/dynamic";
|
|
||||||
const textUriBase: string = `${uriBase}/text`;
|
|
||||||
const blobUriBase: string = `${uriBase}/blob`;
|
|
||||||
const textUriTemplate: string = `${textUriBase}/{index}`;
|
|
||||||
const blobUriTemplate: string = `${blobUriBase}/{index}`;
|
|
||||||
|
|
||||||
// Format a GMT timestamp like "7:30AM GMT on November 3"
|
|
||||||
const formatGmtTimestamp = () => {
|
|
||||||
const d = new Date();
|
|
||||||
const h24 = d.getUTCHours();
|
|
||||||
const minutes = d.getUTCMinutes();
|
|
||||||
const ampm = h24 >= 12 ? "PM" : "AM";
|
|
||||||
let h12 = h24 % 12;
|
|
||||||
if (h12 === 0) h12 = 12;
|
|
||||||
const mm = String(minutes).padStart(2, "0");
|
|
||||||
const months = [
|
|
||||||
"January",
|
|
||||||
"February",
|
|
||||||
"March",
|
|
||||||
"April",
|
|
||||||
"May",
|
|
||||||
"June",
|
|
||||||
"July",
|
|
||||||
"August",
|
|
||||||
"September",
|
|
||||||
"October",
|
|
||||||
"November",
|
|
||||||
"December",
|
|
||||||
];
|
|
||||||
const monthName = months[d.getUTCMonth()];
|
|
||||||
const day = d.getUTCDate();
|
|
||||||
return `${h12}:${mm}${ampm} GMT on ${monthName} ${day}`;
|
|
||||||
};
|
|
||||||
|
|
||||||
const parseIndex = (uri: URL, variables: Record<string, unknown>) => {
|
const parseIndex = (uri: URL, variables: Record<string, unknown>) => {
|
||||||
const uriError = `Unknown resource: ${uri.toString()}`;
|
const uriError = `Unknown resource: ${uri.toString()}`;
|
||||||
if (
|
if (
|
||||||
@@ -71,7 +81,7 @@ export const registerDynamicResources = (server: McpServer) => {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// Text resource registration
|
// Text resource template registration
|
||||||
server.registerResource(
|
server.registerResource(
|
||||||
"Dynamic Text Resource",
|
"Dynamic Text Resource",
|
||||||
new ResourceTemplate(textUriTemplate, { list: undefined }),
|
new ResourceTemplate(textUriTemplate, { list: undefined }),
|
||||||
@@ -83,18 +93,12 @@ export const registerDynamicResources = (server: McpServer) => {
|
|||||||
async (uri, variables) => {
|
async (uri, variables) => {
|
||||||
const index = parseIndex(uri, variables);
|
const index = parseIndex(uri, variables);
|
||||||
return {
|
return {
|
||||||
contents: [
|
contents: [textResource(uri, index)],
|
||||||
{
|
|
||||||
uri: uri.toString(),
|
|
||||||
mimeType: "text/plain",
|
|
||||||
text: `Resource ${index}: This is a plaintext resource created at ${formatGmtTimestamp()}`,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
// Blob resource registration
|
// Blob resource template registration
|
||||||
server.registerResource(
|
server.registerResource(
|
||||||
"Dynamic Blob Resource",
|
"Dynamic Blob Resource",
|
||||||
new ResourceTemplate(blobUriTemplate, { list: undefined }),
|
new ResourceTemplate(blobUriTemplate, { list: undefined }),
|
||||||
@@ -105,17 +109,8 @@ export const registerDynamicResources = (server: McpServer) => {
|
|||||||
},
|
},
|
||||||
async (uri, variables) => {
|
async (uri, variables) => {
|
||||||
const index = parseIndex(uri, variables);
|
const index = parseIndex(uri, variables);
|
||||||
const buffer = Buffer.from(
|
|
||||||
`Resource ${index}: This is a base64 blob created at ${formatGmtTimestamp()}`
|
|
||||||
);
|
|
||||||
return {
|
return {
|
||||||
contents: [
|
contents: [blobResource(uri, index)],
|
||||||
{
|
|
||||||
uri: uri.toString(),
|
|
||||||
mimeType: "application/octet-stream",
|
|
||||||
blob: buffer.toString("base64"),
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
Reference in New Issue
Block a user