mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-18 08:03:26 +02:00
[WIP] Refactor everything server to be more modular and use recommended APIs.
For tools where we seek to get some response from the server, renamed as an action, e.g., "Get Sum" rather than "Add" or "Get Annotated Message" rather than "Annotated Message", so that it's clear what the intent of the tool is in a quick review. * Updated architecture.md * Refactor/renamed add.ts to get-sum.ts * Refactor/renamed annotated-message.ts to get-annotated-message.ts * In tools/index.ts - sorted presentation order
This commit is contained in:
@@ -4,7 +4,7 @@ import { z } from "zod";
|
||||
import { MCP_TINY_IMAGE } from "./get-tiny-image.js";
|
||||
|
||||
// Tool input schema
|
||||
const AnnotatedMessageSchema = z.object({
|
||||
const GetAnnotatedMessageSchema = z.object({
|
||||
messageType: z
|
||||
.enum(["error", "success", "debug"])
|
||||
.describe("Type of message to demonstrate different annotation patterns"),
|
||||
@@ -15,12 +15,12 @@ const AnnotatedMessageSchema = z.object({
|
||||
});
|
||||
|
||||
// Tool configuration
|
||||
const name = "annotated-message";
|
||||
const name = "get-annotated-message";
|
||||
const config = {
|
||||
title: "Annotated Message Tool",
|
||||
title: "Get Annotated Message Tool",
|
||||
description:
|
||||
"Demonstrates how annotations can be used to provide metadata about content.",
|
||||
inputSchema: AnnotatedMessageSchema,
|
||||
inputSchema: GetAnnotatedMessageSchema,
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -35,9 +35,9 @@ const config = {
|
||||
* @function
|
||||
* @param {McpServer} server - The MCP server instance where the Annotated Message Tool is to be registered.
|
||||
*/
|
||||
export const registerAnnotatedMessageTool = (server: McpServer) => {
|
||||
export const registerGetAnnotatedMessageTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
const { messageType, includeImage } = AnnotatedMessageSchema.parse(args);
|
||||
const { messageType, includeImage } = GetAnnotatedMessageSchema.parse(args);
|
||||
|
||||
const content: CallToolResult["content"] = [];
|
||||
|
||||
@@ -3,35 +3,35 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
|
||||
|
||||
// Tool input schema
|
||||
const AddSchema = z.object({
|
||||
const GetSumSchema = z.object({
|
||||
a: z.number().describe("First number"),
|
||||
b: z.number().describe("Second number"),
|
||||
});
|
||||
|
||||
// Tool configuration
|
||||
const name = "add";
|
||||
const name = "get-sum";
|
||||
const config = {
|
||||
title: "Add Tool",
|
||||
description: "Adds two numbers",
|
||||
inputSchema: AddSchema,
|
||||
title: "Get Sum Tool",
|
||||
description: "Gets the sum of two numbers",
|
||||
inputSchema: GetSumSchema,
|
||||
};
|
||||
|
||||
/**
|
||||
* Registers the 'add' tool with the provided McpServer instance.
|
||||
* Registers the 'get-sum' tool with the provided McpServer instance.
|
||||
**
|
||||
* The registered tool processes input arguments, validates them using a predefined schema,
|
||||
* performs addition on two numeric values, and returns the result in a structured format.
|
||||
* calculates the sum of two numeric values, and returns the result in a content block.
|
||||
*
|
||||
* Expects input arguments to conform to a specific schema that includes two numeric properties, `a` and `b`.
|
||||
* Validation is performed to ensure the input adheres to the expected structure before calculating the sum.
|
||||
*
|
||||
* The result is returned as a Promise resolving to an object containing the computed sum in a text format.
|
||||
*
|
||||
* @param {McpServer} server - The server instance where the addition tool will be registered.
|
||||
* @param {McpServer} server - The server instance where the sum tool will be registered.
|
||||
*/
|
||||
export const registerAddTool = (server: McpServer) => {
|
||||
export const registerGetSumTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
const validatedArgs = AddSchema.parse(args);
|
||||
const validatedArgs = GetSumSchema.parse(args);
|
||||
const sum = validatedArgs.a + validatedArgs.b;
|
||||
return {
|
||||
content: [
|
||||
@@ -1,29 +1,29 @@
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
import { registerAddTool } from "./add.js";
|
||||
import { registerAnnotatedMessageTool } from "./annotated-message.js";
|
||||
import { registerGetAnnotatedMessageTool } from "./get-annotated-message.js";
|
||||
import { registerEchoTool } from "./echo.js";
|
||||
import { registerGetEnvTool } from "./get-env.js";
|
||||
import { registerGetResourceLinksTool } from "./get-resource-links.js";
|
||||
import { registerGetResourceReferenceTool } from "./get-resource-reference.js";
|
||||
import { registerGetStructuredContentTool } from "./get-structured-content.js";
|
||||
import { registerGetSumTool } from "./get-sum.js";
|
||||
import { registerGetTinyImageTool } from "./get-tiny-image.js";
|
||||
import { registerLongRunningOperationTool } from "./long-running-operation.js";
|
||||
import { registerSamplingRequestTool } from "./sampling-request.js";
|
||||
import { registerToggleLoggingTool } from "./toggle-logging.js";
|
||||
import { registerToggleSubscriberUpdatesTool } from "./toggle-subscriber-updates.js";
|
||||
import { registerGetStructuredContentTool } from "./get-structured-content.js";
|
||||
|
||||
/**
|
||||
* Register the tools with the MCP server.
|
||||
* @param server
|
||||
*/
|
||||
export const registerTools = (server: McpServer) => {
|
||||
registerAddTool(server);
|
||||
registerAnnotatedMessageTool(server);
|
||||
registerEchoTool(server);
|
||||
registerGetAnnotatedMessageTool(server);
|
||||
registerGetEnvTool(server);
|
||||
registerGetResourceLinksTool(server);
|
||||
registerGetResourceReferenceTool(server);
|
||||
registerGetStructuredContentTool(server);
|
||||
registerGetSumTool(server);
|
||||
registerGetTinyImageTool(server);
|
||||
registerLongRunningOperationTool(server);
|
||||
registerSamplingRequestTool(server);
|
||||
|
||||
Reference in New Issue
Block a user