[WIP] Refactor everything server to be more modular and use recommended APIs.

* Updated architecture.md

* Refactor/renamed static.ts to file.ts

* Refactor/renamed complex.ts to args.ts

* Refactor/renamed template.ts to templates.ts.

* In resource.ts,
  -  improved registerEmbeddedResourcePrompt to allow selection of blob or text resource type.

* In file.ts
  - refactor/renamed registerStaticResources to registerFileResources to highlight the fact that it is using files as resources.

* In args.ts
  - refactor/renamed registerComplexPrompt to registerArgumentsPrompt to highlight the fact that it is demonstrating prompt arguments.

* Updated inline documentation throughout
This commit is contained in:
cliffhall
2025-12-06 15:48:39 -05:00
parent 9084cd3a96
commit 7b2ff6b064
9 changed files with 168 additions and 62 deletions

View File

@@ -0,0 +1,128 @@
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
* - Exposed for use by embedded resource prompt example
* @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
* - Exposed for use by embedded resource prompt example
* @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
* - Exposed for use by embedded resource prompt example
* @param index
*/
export const textResourceUri = (index: number) =>
new URL(`${textUriBase}/${index}`);
/**
* Create a dynamic blob resource URI
* - Exposed for use by embedded resource prompt example
* @param index
*/
export const blobResourceUri = (index: number) =>
new URL(`${blobUriBase}/${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) => {
// Parse the index from the URI
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);
}
}
};
// Register the text resource template
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)],
};
}
);
// Register the blob resource template
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)],
};
}
);
};