Guía de Desarrollo de Servidores MCP
Descripción General
Cree servidores MCP (Model Context Protocol) que permitan a los LLMs interactuar con servicios externos a través de herramientas bien diseñadas. La calidad de un servidor MCP se mide por qué tan bien permite a los LLMs realizar tareas del mundo real.
Proceso
🚀 Flujo de Trabajo de Alto Nivel
Crear un servidor MCP de alta calidad implica cuatro fases principales:
Fase 1: Investigación y Planificación Profunda
1.1 Comprender el Diseño Moderno de MCP
Cobertura de API vs. Herramientas de Flujo de Trabajo: Equilibre la cobertura completa de endpoints de API con herramientas de flujo de trabajo especializadas. Las herramientas de flujo de trabajo pueden ser más convenientes para tareas específicas, mientras que la cobertura completa brinda a los agentes flexibilidad para componer operaciones. El rendimiento varía según el cliente: algunos clientes se benefician de la ejecución de código que combina herramientas básicas, mientras que otros funcionan mejor con flujos de trabajo de nivel superior. Cuando haya incertidumbre, priorice la cobertura completa de API.
Nomenclatura y Descubribilidad de Herramientas:
Nombres de herramientas claros y descriptivos ayudan a los agentes a encontrar las herramientas adecuadas rápidamente. Use prefijos consistentes (por ejemplo, github_create_issue, github_list_repos) y nombres orientados a la acción.
Gestión de Contexto: Los agentes se benefician de descripciones concisas de herramientas y la capacidad de filtrar/paginar resultados. Diseñe herramientas que devuelvan datos enfocados y relevantes. Algunos clientes admiten la ejecución de código, lo que puede ayudar a los agentes a filtrar y procesar datos de manera eficiente.
Mensajes de Error Accionables: Los mensajes de error deben guiar a los agentes hacia soluciones con sugerencias específicas y próximos pasos.
1.2 Estudiar la Documentación del Protocolo MCP
Navegue por la especificación de MCP:
Comience con el mapa del sitio para encontrar páginas relevantes: https://modelcontextprotocol.io/sitemap.xml
Luego obtenga páginas específicas con el sufijo .md para formato markdown (por ejemplo, https://modelcontextprotocol.io/specification/draft.md).
Páginas clave a revisar:
- Descripción general y arquitectura de la especificación
- Mecanismos de transporte (HTTP transmisible, stdio)
- Definiciones de herramientas, recursos y prompts
1.3 Estudiar la Documentación del Framework
Stack recomendado:
- Lenguaje: TypeScript (soporte SDK de alta calidad y buena compatibilidad en muchos entornos de ejecución, por ejemplo, MCPB. Además, los modelos de IA son buenos generando código TypeScript, beneficiándose de su amplio uso, tipado estático y buenas herramientas de linting)
- Transporte: HTTP transmisible para servidores remotos, usando JSON sin estado (más simple de escalar y mantener, en oposición a sesiones con estado y respuestas en streaming). stdio para servidores locales.
Cargue la documentación del framework:
- Mejores Prácticas de MCP: 📋 Ver Mejores Prácticas - Pautas principales
Para TypeScript (recomendado):
- SDK de TypeScript: Use WebFetch para cargar
https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md - ⚡ Guía de TypeScript - Patrones y ejemplos de TypeScript
Para Python:
- SDK de Python: Use WebFetch para cargar
https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md - 🐍 Guía de Python - Patrones y ejemplos de Python
1.4 Planifique su Implementación
Comprenda la API: Revise la documentación de la API del servicio para identificar endpoints clave, requisitos de autenticación y modelos de datos. Use la búsqueda web y WebFetch según sea necesario.
Selección de Herramientas: Priorice la cobertura completa de API. Enumere los endpoints a implementar, comenzando con las operaciones más comunes.
Fase 2: Implementación
2.1 Configurar la Estructura del Proyecto
Consulte las guías específicas de lenguaje para la configuración del proyecto:
- ⚡ Guía de TypeScript - Estructura del proyecto, package.json, tsconfig.json
- 🐍 Guía de Python - Organización de módulos, dependencias
2.2 Implementar la Infraestructura Central
Cree utilidades compartidas:
- Cliente API con autenticación
- Ayudantes para el manejo de errores
- Formateo de respuestas (JSON/Markdown)
- Soporte de paginación
2.3 Implementar Herramientas
Para cada herramienta:
Esquema de Entrada:
- Use Zod (TypeScript) o Pydantic (Python)
- Incluya restricciones y descripciones claras
- Agregue ejemplos en las descripciones de los campos
Esquema de Salida:
- Defina
outputSchemacuando sea posible para datos estructurados - Use
structuredContenten las respuestas de la herramienta (característica del SDK de TypeScript) - Ayuda a los clientes a entender y procesar las salidas de la herramienta
Descripción de la Herramienta:
- Resumen conciso de la funcionalidad
- Descripciones de parámetros
- Esquema del tipo de retorno
Implementación:
- Async/await para operaciones de E/S
- Manejo adecuado de errores con mensajes accionables
- Soporte de paginación cuando corresponda
- Devuelva tanto contenido de texto como datos estructurados cuando use SDKs modernos
Anotaciones:
readOnlyHint: verdadero/falsodestructiveHint: verdadero/falsoidempotentHint: verdadero/falsoopenWorldHint: verdadero/falso
Fase 3: Revisión y Pruebas
3.1 Calidad del Código
Revise para:
- Sin código duplicado (principio DRY)
- Manejo de errores consistente
- Cobertura de tipos completa
- Descripciones claras de herramientas
3.2 Compilación y Pruebas
TypeScript:
- Ejecute
npm run buildpara verificar la compilación - Pruebe con MCP Inspector:
npx @modelcontextprotocol/inspector
Python:
- Verifique la sintaxis:
python -m py_compile tu_servidor.py - Pruebe con MCP Inspector
Consulte las guías específicas de lenguaje para enfoques de prueba detallados y listas de verificación de calidad.
Fase 4: Crear Evaluaciones
Después de implementar su servidor MCP, cree evaluaciones completas para probar su efectividad.
Cargue la ✅ Guía de Evaluación para pautas completas de evaluación.
4.1 Comprender el Propósito de la Evaluación
Use evaluaciones para probar si los LLMs pueden usar efectivamente su servidor MCP para responder preguntas realistas y complejas.
4.2 Crear 10 Preguntas de Evaluación
Para crear evaluaciones efectivas, siga el proceso descrito en la guía de evaluación:
- Inspección de Herramientas: Enumere las herramientas disponibles y comprenda sus capacidades
- Exploración de Contenido: Use operaciones de SOLO LECTURA para explorar los datos disponibles
- Generación de Preguntas: Cree 10 preguntas complejas y realistas
- Verificación de Respuestas: Resuelva cada pregunta usted mismo para verificar las respuestas
4.3 Requisitos de Evaluación
Asegúrese de que cada pregunta sea:
- Independiente: No dependiente de otras preguntas
- Solo Lectura: Solo se requieren operaciones no destructivas
- Compleja: Requiere múltiples llamadas a herramientas y exploración profunda
- Realista: Basada en casos de uso reales que interesarían a los humanos
- Verificable: Respuesta única y clara que pueda verificarse mediante comparación de cadenas
- Estable: La respuesta no cambiará con el tiempo
4.4 Formato de Salida
Cree un archivo XML con esta estructura:
<evaluation>
<qa_pair>
<question>Encuentra discusiones sobre lanzamientos de modelos de IA con nombres en clave de animales. Un modelo necesitaba una designación de seguridad específica que usa el formato ASL-X. ¿Qué número X se estaba determinando para el modelo nombrado después de un gato salvaje manchado?</question>
<answer>3</answer>
</qa_pair>
<!-- Más qa_pairs... -->
</evaluation>
Archivos de Referencia
📚 Biblioteca de Documentación
Cargue estos recursos según sea necesario durante el desarrollo:
Documentación Central de MCP (Cargar Primero)
- Protocolo MCP: Comience con el mapa del sitio en
https://modelcontextprotocol.io/sitemap.xml, luego obtenga páginas específicas con el sufijo.md - 📋 Mejores Prácticas de MCP - Pautas universales de MCP que incluyen:
- Convenciones de nomenclatura de servidores y herramientas
- Pautas de formato de respuesta (JSON vs Markdown)
- Mejores prácticas de paginación
- Selección de transporte (HTTP transmisible vs stdio)
- Estándares de seguridad y manejo de errores
Documentación del SDK (Cargar Durante la Fase 1/2)
- SDK de Python: Obtenga de
https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md - SDK de TypeScript: Obtenga de
https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md
Guías de Implementación Específicas de Lenguaje (Cargar Durante la Fase 2)
-
🐍 Guía de Implementación de Python - Guía completa de Python/FastMCP con:
- Patrones de inicialización de servidor
- Ejemplos de modelos Pydantic
- Registro de herramientas con
@mcp.tool - Ejemplos completos funcionales
- Lista de verificación de calidad
-
⚡ Guía de Implementación de TypeScript - Guía completa de TypeScript con:
- Estructura del proyecto
- Patrones de esquema Zod
- Registro de herramientas con
server.registerTool - Ejemplos completos funcionales
- Lista de verificación de calidad
Guía de Evaluación (Cargar Durante la Fase 4)
- ✅ Guía de Evaluación - Guía completa de creación de evaluaciones con:
- Pautas de creación de preguntas
- Estrategias de verificación de respuestas
- Especificaciones de formato XML
- Ejemplos de preguntas y respuestas
- Ejecución de una evaluación con los scripts proporcionados