[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:
cliffhall 2025-12-06 12:50:09 -05:00
commit 0aeb8a794d
5 changed files with 115 additions and 62 deletions

View file

@ -30,10 +30,11 @@ src/everything
│ ├── index.ts
│ ├── simple.ts
│ ├── complex.ts
│ └── completions.ts
│ ├── completions.ts
│ └── resource.ts
├── resources
│ ├── index.ts
│ ├── dynamic.ts
│ ├── template.ts
│ └── static.ts
├── docs
│ ├── 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.
- 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`).
- 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/
- index.ts
- `registerResources(server)` orchestrator; delegates to static and dynamic resources.
- dynamic.ts
- `registerResources(server)` orchestrator; delegates to template‑based dynamic resources and static resources by calling `registerResourceTemplates(server)` and `registerStaticResources(server)`.
- template.ts
- Registers two dynamic, template‑driven resources using `ResourceTemplate`:
- Text: `demo://resource/dynamic/text/{index}` (MIME: `text/plain`)
- 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
- Registers static resources for each file in the `docs/` folder.
- 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.
- `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.
- `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
- Dynamic Text: `demo://resource/dynamic/text/{index}` (content generated on the fly)

View file

@ -2,6 +2,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { registerSimplePrompt } from "./simple.js";
import { registerComplexPrompt } from "./complex.js";
import { registerPromptWithCompletions } from "./completions.js";
import { registerEmbeddedResourcePrompt } from "./resource.js"
/**
* Register the prompts with the MCP server.
@ -11,4 +12,5 @@ export const registerPrompts = (server: McpServer) => {
registerSimplePrompt(server);
registerComplexPrompt(server);
registerPromptWithCompletions(server);
registerEmbeddedResourcePrompt(server);
};

View 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,
},
},
],
};
}
);
};

View file

@ -1,5 +1,5 @@
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { registerDynamicResources } from "./dynamic.js";
import { registerResourceTemplates } from "./template.js";
import { registerStaticResources } from "./static.js";
/**
@ -7,6 +7,6 @@ import { registerStaticResources } from "./static.js";
* @param server
*/
export const registerResources = (server: McpServer) => {
registerDynamicResources(server);
registerResourceTemplates(server);
registerStaticResources(server);
};

View file

@ -0,0 +1,117 @@
import {
McpServer,
ResourceTemplate,
} 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}`;
/**
* 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
* - Any finite integer is acceptable for the index variable
* - List resources method will not return these resources
* - These are only accessible via template URIs
* - Both blob and text resources:
* - have content that is dynamically generated, including a timestamp
* - have different template URIs
* - Blob: "demo://resource/dynamic/blob/{index}"
* - Text: "demo://resource/dynamic/text/{index}"
*
* @param server
*/
export const registerResourceTemplates = (server: McpServer) => {
const parseIndex = (uri: URL, variables: Record<string, unknown>) => {
const uriError = `Unknown resource: ${uri.toString()}`;
if (
uri.toString().startsWith(textUriBase) &&
uri.toString().startsWith(blobUriBase)
) {
throw new Error(uriError);
} else {
const idxStr = String((variables as any).index ?? "");
const idx = Number(idxStr);
if (Number.isFinite(idx) && Number.isInteger(idx)) {
return idx;
} else {
throw new Error(uriError);
}
}
};
// Text resource template registration
server.registerResource(
"Dynamic Text Resource",
new ResourceTemplate(textUriTemplate, { list: undefined }),
{
mimeType: "text/plain",
description:
"Plaintext dynamic resource fabricated from the {index} variable, which must be an integer.",
},
async (uri, variables) => {
const index = parseIndex(uri, variables);
return {
contents: [textResource(uri, index)],
};
}
);
// Blob resource template registration
server.registerResource(
"Dynamic Blob Resource",
new ResourceTemplate(blobUriTemplate, { list: undefined }),
{
mimeType: "application/octet-stream",
description:
"Binary (base64) dynamic resource fabricated from the {index} variable, which must be an integer.",
},
async (uri, variables) => {
const index = parseIndex(uri, variables);
return {
contents: [blobResource(uri, index)],
};
}
);
};