mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-21 16:25:39 +02:00
* Adding static resources, move server instructions to
the new docs folder, and add code formatting
* Add docs folder
* Add docs/architecture.md which describes the architecture of the project thus far.
* Refactor moved instructions.md to docs/server-instructions.md
* Add resources/static.ts
- in addStaticResources()
- read the file entries from the docs folder
- register each file as a resource (no template), with a readResource function that reads the file and returns it in a contents block with the appropriate mime type and contents
- getMimeType helper function gets the mime type for a filename
- readSafe helper function reads the file synchronously as utf-8 or returns an error string
* Add resources/index.ts
- import addStaticResources
- export registerResources function
- in registerResources()
- call addStaticResources
* In package.json
- add prettier devDependency
- add prettier:check script
- add prettier:fix script
- in build script, copy docs folder to dist
* All other changes were prettier formatting
123 lines
3.6 KiB
TypeScript
123 lines
3.6 KiB
TypeScript
import {
|
|
McpServer,
|
|
ResourceTemplate,
|
|
} from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
|
|
/**
|
|
* Register dynamic resources 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: "test://dynamic/resource/blob/{index}"
|
|
* - Text: "test://dynamic/resource/text/{index}"
|
|
*
|
|
* @param server
|
|
*/
|
|
export const addDynamicResources = (server: McpServer) => {
|
|
const uriBase: string = "test://dynamic/resource";
|
|
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 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 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: [
|
|
{
|
|
uri: uri.toString(),
|
|
mimeType: "text/plain",
|
|
text: `Resource ${index}: This is a plaintext resource created at ${formatGmtTimestamp()}`,
|
|
},
|
|
],
|
|
};
|
|
}
|
|
);
|
|
|
|
// Blob resource 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);
|
|
const buffer = Buffer.from(
|
|
`Resource ${index}: This is a base64 blob created at ${formatGmtTimestamp()}`
|
|
);
|
|
return {
|
|
contents: [
|
|
{
|
|
uri: uri.toString(),
|
|
mimeType: "application/octet-stream",
|
|
blob: buffer.toString("base64"),
|
|
},
|
|
],
|
|
};
|
|
}
|
|
);
|
|
};
|