MCP-Typescribe

MCP-Typescribe: un servidor MCP que proporciona información de API de LLM

El problema

Los Modelos de Lenguaje Grandes (LLM) han logrado avances increíbles en la generación de código y la productividad de los desarrolladores. Sin embargo, se enfrentan a una limitación clave: solo pueden usar de forma fiable las API y bibliotecas que han visto durante el entrenamiento. Esto crea un cuello de botella para la adopción de nuevas herramientas, SDK o API internas; los LLM simplemente no saben cómo utilizarlos eficazmente.

Si bien se puede otorgar a las herramientas acceso al código fuente (al interactuar con APIs cuyas fuentes están disponibles) o a archivos de documentación (por ejemplo, archivos de definición de tipos de TypeScript), esto no es escalable para APIs grandes. Los LLM necesitan una forma más eficiente de aprender más sobre una API. Contextualizar toda la documentación para cada solicitud es ineficiente, inviable y genera malos resultados.

Como resultado:

Las API nuevas o internas de mayor tamaño permanecen "invisibles" para los LLM.

Los desarrolladores deben guiar manualmente los LLM o proporcionar ejemplos de uso.

La innovación se ve frenada por el retraso entre el lanzamiento de una API y su comprensión generalizada por parte de las herramientas de IA.

La idea

Este proyecto es una implementación de código abierto del Protocolo de Contexto de Modelo (MCP), un protocolo diseñado para proporcionar a los LLM acceso contextual y en tiempo real a la información. En este caso, se trata de la documentación de la API y, por ahora, en este proyecto, de las definiciones de TypeScript.

Nuestro objetivo es:

Analizar definiciones de TypeScript (y otras) en un formato legible por máquina.

Ofrezca este contexto de forma dinámica a los LLM a través de herramientas como Claude, Cline, Cursor o Windsurf y otras interfaces personalizadas.

Habilite el comportamiento agente permitiendo que los LLM consulten, planifiquen y se adapten a API desconocidas sin necesidad de volver a capacitarse.

Lo que esto permite

Compatibilidad con API plug-and-play para asistentes de codificación basados en LLM.

Incorporación más rápida para SDK nuevos o propietarios.

Un paso hacia agentes de codificación más autónomos y conscientes del contexto.

Descripción general del proyecto

Este proyecto permite a los agentes de IA explorar y comprender eficientemente APIs de TypeScript desconocidas. Carga documentación JSON generada por TypeDoc y la expone mediante un conjunto de puntos de consulta que permiten a los agentes buscar símbolos, obtener información detallada sobre partes específicas de la API y comprender las relaciones entre los diferentes componentes.

Características actuales

• Integración con TypeDoc : carga e indexa la documentación JSON de TypeDoc para realizar consultas eficientes
• Capacidades de consulta integrales : proporciona una amplia gama de herramientas para explorar las API de TypeScript
• Protocolo MCP : sigue el protocolo de contexto del modelo para una integración perfecta con agentes de IA

Capacidades de consulta

El servidor proporciona las siguientes herramientas para consultar la API:

• search_symbols : busca símbolos por nombre con filtrado opcional por tipo
• get_symbol_details : Obtener información detallada sobre un símbolo específico
• list_members : enumera los métodos y propiedades de una clase o interfaz
• get_parameter_info : Obtener información sobre los parámetros de la función
• find_implementations : Encuentra implementaciones de interfaces o subclases
• search_by_return_type : busca funciones que devuelvan un tipo específico
• search_by_description : Buscar en los comentarios de JSDoc
• get_type_hierarchy : Mostrar relaciones de herencia
• find_usages : Encuentra dónde se utiliza un tipo/función

Empezando

Prerrequisitos

• Node.js
• npm

Instalación

1. Clonar el repositorio
2. Instalar dependencias:
   npm install

Uso

1. Genere JSON de TypeDoc para su API de TypeScript:
   npx typedoc --json docs/api.json --entryPointStrategy expand path/to/your/typescript/files
   Si (solo) tiene un archivo .d.ts existente, puede crear un archivo json de API de la siguiente manera:Cree un tsconfig.docs.json separado:
   { "extends": "./tsconfig.json", "files": ["existing.d.ts"], "typedocOptions": { "entryPoints": ["existing.d.ts"], "json": "docs/api.json", "pretty": false } }
   Entonces hazlo
   npx typedoc --tsconfig tsconfig.docs.json
2. Construir el proyecto:
   npm run build
3. Explorar el servidor MCP:
   npx @modelcontextprotocol/inspector node ./dist/mcp-server/cli.js run-server docs/api.json
4. Conecte un agente de IA al servidor para consultar la APIPor ejemplo, con cline en VSCode, especifique el siguiente servidor MCP en cline_mcp_settings.json :
   { "mcpServers": { "typescribe": { "command": "npx", "args": [ "-y", "mcp-typescribe@latest", "run-server", "<PATH_TO_API_DOT_JSON>" ], "env": {} } } }
5. Habilite el servidor y probablemente apruebe automáticamente las distintas herramientas. Indique al agente que use la herramienta "typescribe" para conocer su API.

Estructura del proyecto

• src/sample-api/ : Una API de TypeScript de muestra para pruebas: utiliza un dialecto extraño similar al alemán para los nombres de la API para probar que el LLM no alucina la API
• src/mcp-server/ : La implementación del servidor MCP
  • utils/ : Funciones de utilidad
  • schemas/ : esquemas JSON para las herramientas MCP
  • core/ : Funcionalidad principal
  • server.ts : La implementación del servidor MCP
  • index.ts : Punto de entrada para las exportaciones de la biblioteca
  • cli.ts : el punto de entrada para CLI/binario
• tests/ : Pruebas para la funcionalidad de la API

Desarrollo

Ejecución de pruebas

Edificio

Licencia

Instituto Tecnológico de Massachusetts (MIT)

Derechos de autor 2025 yWorks GmbH - https://www.yworks.com