Servidor MCP de Shortcut.com

Una implementación de un servidor de Protocolo de Contexto de Modelo (MCP) para acceder y buscar tickets en Shortcut.com.

Descripción general

Este proyecto implementa un servidor MCP que permite a Claude y a otros asistentes de IA compatibles con MCP interactuar con el sistema de gestión de tickets de Shortcut.com. Con esta integración, los asistentes de IA pueden:

• Listado y búsqueda de historias (tickets) en Shortcut
• Obtenga información detallada sobre historias específicas
• Crea nuevas historias
• Actualizar historias existentes
• Añadir comentarios a las historias
• Recuperar estados de flujo de trabajo y proyectos

Prerrequisitos

• Python 3.10+
• Token de API de Shortcut.com

Instalación

1. Clonar este repositorio:
   git clone https://github.com/yourusername/mcp-server-shortcut.git cd mcp-server-shortcut
2. Cree un entorno virtual e instale dependencias:
   # Using uv (recommended) curl -LsSf https://astral.sh/uv/install.sh | sh # For Mac/Linux uv venv source .venv/bin/activate # On Mac/Linux or .venv\Scripts\activate on Windows uv pip install -r requirements.txt # Using pip python -m venv venv source venv/bin/activate # On Mac/Linux or venv\Scripts\activate on Windows pip install -r requirements.txt
3. Cree un archivo .env en el directorio raíz del proyecto con su token de API de acceso directo:
   SHORTCUT_API_TOKEN=your_token_here SERVER_PORT=5000 SERVER_HOST=0.0.0.0 DEBUG_MODE=True

Ejecución del servidor

Inicie el servidor MCP usando:

Configuración de Claude Desktop

Para utilizar este servidor MCP con Claude Desktop:

1. Editar el archivo de configuración de Claude Desktop:
   • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Ventanas: %APPDATA%\Claude\claude_desktop_config.json
2. Agregue la configuración del servidor MCP:
   { "mcpServers": { "shortcut": { "command": "python", "args": ["-m", "src.server"], "env": { "SHORTCUT_API_TOKEN": "your_token_here" } } } }
3. Reinicie Claude Desktop.

Capacidades MCP disponibles

Recursos

• shortcut://stories - Accede a una lista de historias
• shortcut://story/{story_id} - Acceder a una historia específica

Herramientas

• list_stories - Lista de historias con filtrado opcional
• search_stories - Busca historias mediante consultas de texto
• get_story_details - Obtenga información detallada sobre una historia específica
• create_story - Crea una nueva historia
• update_story - Actualizar una historia existente
• add_comment - Agregar un comentario a una historia
• list_workflow_states : enumera todos los estados del flujo de trabajo
• list_projects - Lista todos los proyectos

Indicaciones

• create_bug_report - Generar una plantilla para informes de errores
• create_feature_request - Generar una plantilla para solicitudes de funciones

Estructura del proyecto

• src/ - Directorio del código fuente
  • server.py - Implementación del servidor MCP principal
  • config.py - Gestión de configuración
  • shortcut_client.py - Cliente para la API de acceso directo
  • utils.py - Funciones de utilidad y modelos de datos
• requirements.txt - Dependencias del proyecto
• .env - Variables de entorno (no rastreadas en git)

Desarrollo

Añadiendo nuevas capacidades

Para agregar una nueva capacidad al servidor MCP:

1. Agregue cualquier método API nuevo a shortcut_client.py
2. Defina modelos de Pydantic en utils.py si es necesario
3. Implemente la funcionalidad MCP usando decoradores en server.py :
   • Utilice @mcp.resource() para recursos de solo lectura
   • Utilice @mcp.tool() para acciones que puedan modificar datos
   • Utilice @mcp.prompt() para generar plantillas o texto estructurado

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

Licencia

Licencia MIT