README Documentation
Chop MCP TypeScript
Este proyecto implementa un servidor MCP (Model Context Protocol) para interactuar con el sistema de Setups de Chop. Proporciona una interfaz para obtener información de setups a través de una API REST.
Características
- Implementación del Model Context Protocol (MCP)
- Herramienta para obtener información de setups por ID
- Comunicación con API REST local
- Implementado en TypeScript con tipado estricto
Requisitos Previos
- Node.js (versión recomendada: >= 16)
- npm o yarn
- TypeScript
- Instala las dependencias:
npm install
Configuración
El proyecto utiliza TypeScript y está configurado con tsconfig.json
. Las principales dependencias incluyen:
@modelcontextprotocol/sdk
: SDK para implementación de MCPaxios
: Cliente HTTP para realizar peticioneszod
: Validación de esquemas- TypeScript y herramientas de desarrollo relacionadas
Uso
Para iniciar el servidor MCP:
npm start
Herramientas Disponibles
obtener-setup
Esta herramienta permite obtener información detallada de un setup específico.
Parámetros:
setup_id
(number): El ID del setup a consultar
Ejemplo de uso:
// La herramienta se conecta a http://localhost:8080/backoffice/setup/{setup_id}
// y devuelve la información del setup en formato JSON
Estructura del Proyecto
main.ts
: Punto de entrada de la aplicación y configuración del servidor MCPtypes.ts
: Definiciones de tipos TypeScriptpackage.json
: Configuración del proyecto y dependenciastsconfig.json
: Configuración de TypeScript
Scripts Disponibles
npm start
: Inicia el servidor MCPnpm run build
: Compila el proyecto TypeScript
Desarrollo
Para contribuir al proyecto:
- Asegúrate de tener todas las dependencias instaladas
- Realiza tus cambios en una nueva rama
- Ejecuta las pruebas (cuando estén implementadas)
- Envía un pull request
Add to client LLM
- Agregarlo al client modo Dev
"ChopSetup-ts": {
"command": "npx",
"args": [
"-y",
"tsx",
"{your}/chop-mcp-ts/main.ts"
]
}
- Correr el debug
npx -y @modelcontextprotocol/inspector npx -y tsx main.ts
: Compila el proyecto TypeScript
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source