Plantilla de servidor MCP

Una plantilla para crear servidores de Protocolo de Contexto de Modelo (MCP) en TypeScript. Esta plantilla proporciona una base sólida para construir servidores compatibles con MCP con las herramientas adecuadas, seguridad de tipos y las mejores prácticas.

Características

• 🚀 Compatibilidad total con TypeScript

• 🏗️ Inyección de dependencia basada en contenedores

• 📦 Arquitectura basada en servicios con interfaz DataProcessor

• 🛠️ Ejemplo de implementación de la herramienta con pruebas

• Marco de pruebas Vitest

• 📝 Definiciones de tipos

• 🔌 Integración del SDK de MCP

Related MCP server: MCP Server Template

Empezando

Desarrollo

1. Instalar dependencias:

   npm install

2. Inicie el servidor de desarrollo con recarga en caliente:

   npm run dev

3. Construir el proyecto:

   npm run build

4. Ejecutar pruebas:

   npm test

5. Inicie el servidor de producción:

   npm start

Estructura del proyecto

src/
├── index.ts          # Entry point
├── interfaces/       # Interface definitions
│   └── tool.ts      # DataProcessor interface
└── tools/           # Tool implementations
    └── example.ts   # Example tool

Creación de herramientas

1. Exporte su herramienta y controladores siguiendo el ejemplo en src/tools/example.ts :

   // In your-tool.ts
   export const YOUR_TOOLS = [
     {
       name: "your-tool-name",
       description: "Your tool description",
       parameters: {
         // Your tool parameters schema
       },
     },
   ];
   
   export const YOUR_HANDLERS = {
     "your-tool-name": async (request) => {
       // Your tool handler implementation
       return {
         toolResult: {
           content: [{ type: "text", text: "Result" }],
         },
       };
     },
   };

2. Registre su herramienta en las constantes ALL_TOOLS y ALL_HANDLERS en src/index.ts :

   // In src/index.ts
   import { YOUR_TOOLS, YOUR_HANDLERS } from "./tools/your-tool.js";
   
   // Combine all tools
   const ALL_TOOLS = [...EXAMPLE_TOOLS, ...YOUR_TOOLS];
   const ALL_HANDLERS = { ...EXAMPLE_HANDLERS, ...YOUR_HANDLERS };

El servidor automáticamente:

• Enumere su herramienta en las herramientas disponibles

• Manejar la validación de entrada

• Procesar solicitudes a su herramienta

• Formatear respuestas según el protocolo MCP

Pruebas

La plantilla incluye un TestClient integrado para pruebas locales y el MCP Inspector para depuración visual.

Uso de TestClient

TestClient proporciona una forma sencilla de probar sus herramientas:

import { TestClient } from "./utils/TestClient";

describe("YourTool", () => {
  const client = new TestClient();

  it("should process data correctly", async () => {
    await client.assertToolCall(
      "your-tool-name",
      { input: "test" },
      (result) => {
        expect(result.toolResult.content).toBeDefined();
      }
    );
  });
});

Uso del inspector MCP

La plantilla incluye el Inspector MCP para la depuración visual de sus herramientas:

1. Iniciar el inspector:

   npx @modelcontextprotocol/inspector node dist/index.js

2. Abra la interfaz de usuario del inspector en http://localhost:5173

El inspector proporciona:

• Interfaz visual para herramientas de prueba

• Monitoreo de solicitudes y respuestas en tiempo real

• Inspección de metadatos de la herramienta

• Entorno de pruebas interactivo

Pruebas locales con cursor

Para probar su servidor MCP localmente con Cursor:

1. Construya y vincule el paquete:

   npm run build
   npm run link

2. Verificar que el binario funciona:

   npx example-mcp-tool

3. Añade el servidor al Cursor:

   • Abrir la configuración del cursor

   • Vaya a la pestaña Características

   • Desplácese hacia abajo hasta la sección Servidores MCP

   • Haga clic en "Agregar servidor"

   • Seleccione el tipo "Comando"

   • Asígnele un nombre (por ejemplo, "Herramienta de ejemplo local")

   • Ingrese el comando: npx example-mcp-tool

   • Haga clic en Confirmar

4. Verifique que el servidor se inicie correctamente en Cursor verificando que la sección Servidores MCP muestre que su servidor está en ejecución.

Nota: Si realiza cambios en su código, recuerde reconstruirlo y volver a vincularlo:

npm run build
npm run link

Cuando hayas terminado de probar, puedes desvincular el paquete:

npm run unlink

Esto eliminará el enlace simbólico global creado durante el desarrollo.