mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-18 00:03:23 +02:00
[WIP] Adding Gzip File as Resource tool
* Updated architecture.md
* Added gzip-file-as-resource.ts
- imports getSessionResourceURI and registerSessionResource from session.ts
- exports registerGZipFileAsResourceTool
- the registered tool
- validates the input URI
- fetches the file safely
- compresses it
- creates and registers the resource
- returns resource or resource link
* In tools/index.ts
- import registerGZipFileAsResourceTool
- in registerTools,
- call registerGZipFileAsResourceTool passing server
* Added resources/session.ts
- getSessionResourceURI gets a uri to the specified name
- registerSessionResource registers the session-scoped resource and returns a resource link
64 lines
2.0 KiB
TypeScript
64 lines
2.0 KiB
TypeScript
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
import { Resource, ResourceLink } from "@modelcontextprotocol/sdk/types.js";
|
|
|
|
/**
|
|
* Generates a session-scoped resource URI string based on the provided resource name.
|
|
*
|
|
* @param {string} name - The name of the resource to create a URI for.
|
|
* @returns {string} The formatted session resource URI.
|
|
*/
|
|
export const getSessionResourceURI = (name: string): string => {
|
|
return `demo://resource/session/${name}`;
|
|
};
|
|
|
|
/**
|
|
* Registers a session-scoped resource with the provided server and returns a resource link.
|
|
*
|
|
* The registered resource is available during the life of the session only; it is not otherwise persisted.
|
|
*
|
|
* @param {McpServer} server - The server instance responsible for handling the resource registration.
|
|
* @param {Resource} resource - The resource object containing metadata such as URI, name, description, and mimeType.
|
|
* @param {"text"|"blob"} type
|
|
* @param payload
|
|
* @returns {ResourceLink} An object representing the resource link, with associated metadata.
|
|
*/
|
|
export const registerSessionResource = (
|
|
server: McpServer,
|
|
resource: Resource,
|
|
type: "text" | "blob",
|
|
payload: string
|
|
): ResourceLink => {
|
|
// Destructure resource
|
|
const { uri, name, mimeType, description, title, annotations, icons, _meta } =
|
|
resource;
|
|
|
|
// Prepare the resource content to return
|
|
// See https://modelcontextprotocol.io/specification/2025-11-25/server/resources#resource-contents
|
|
const resourceContent =
|
|
type === "text"
|
|
? {
|
|
uri: uri.toString(),
|
|
mimeType,
|
|
text: payload,
|
|
}
|
|
: {
|
|
uri: uri.toString(),
|
|
mimeType,
|
|
blob: payload,
|
|
};
|
|
|
|
// Register file resource
|
|
server.registerResource(
|
|
name,
|
|
uri,
|
|
{ mimeType, description, title, annotations, icons, _meta },
|
|
async (uri) => {
|
|
return {
|
|
contents: [resourceContent],
|
|
};
|
|
}
|
|
);
|
|
|
|
return { type: "resource_link", ...resource };
|
|
};
|