Сервер MCP Shortcut.com

Реализация сервера Model Context Protocol (MCP) для доступа и поиска тикетов на Shortcut.com.

Обзор

Этот проект реализует сервер MCP, который позволяет Клоду и другим совместимым с MCP помощникам ИИ взаимодействовать с системой управления тикетами Shortcut.com. Благодаря этой интеграции помощники ИИ могут:

• Список и поиск историй (тикетов) в Shortcut

• Получите подробную информацию о конкретных историях

• Создавайте новые истории

• Обновить существующие истории

• Добавляйте комментарии к историям

• Извлечение состояний рабочего процесса и проектов

Related MCP server: Shortcut MCP Server

Предпосылки

• Питон 3.10+

• API-токен Shortcut.com

Установка

1. Клонируйте этот репозиторий:

   git clone https://github.com/yourusername/mcp-server-shortcut.git
   cd mcp-server-shortcut

2. Создайте виртуальную среду и установите зависимости:

   # 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. Создайте файл .env в корневом каталоге проекта с вашим токеном Shortcut API:

   SHORTCUT_API_TOKEN=your_token_here
   SERVER_PORT=5000
   SERVER_HOST=0.0.0.0
   DEBUG_MODE=True

Запуск сервера

Запустите сервер MCP с помощью:

python -m src.server

Настройка рабочего стола Claude

Чтобы использовать этот MCP-сервер с Claude Desktop:

1. Отредактируйте файл конфигурации Claude Desktop:

   • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json

   • Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Добавьте конфигурацию сервера MCP:

   {
     "mcpServers": {
       "shortcut": {
         "command": "python",
         "args": ["-m", "src.server"],
         "env": {
           "SHORTCUT_API_TOKEN": "your_token_here"
         }
       }
     }
   }

3. Перезагрузите Claude Desktop.

Доступные возможности MCP

Ресурсы

• shortcut://stories — доступ к списку историй

• shortcut://story/{story_id} — доступ к определенной истории

Инструменты

• list_stories — список историй с возможностью фильтрации

• search_stories - Поиск историй с помощью текстовых запросов

• get_story_details - Получить подробную информацию о конкретной истории

• create_story - Создать новую историю

• update_story — Обновить существующую историю

• add_comment - Добавить комментарий к истории

• list_workflow_states — список всех состояний рабочего процесса

• list_projects - Список всех проектов

Подсказки

• create_bug_report — создать шаблон для отчетов об ошибках

• create_feature_request — создание шаблона для запросов функций

Структура проекта

• src/ - Каталог исходного кода

  • server.py — Основная реализация сервера MCP

  • config.py — Управление конфигурацией

  • shortcut_client.py — Клиент для API Shortcut

  • utils.py — Вспомогательные функции и модели данных

• requirements.txt — Зависимости проекта

• .env — переменные среды (не отслеживаются в git)

Разработка

Добавление новых возможностей

Чтобы добавить новую возможность на сервер MCP:

1. Добавьте любые новые методы API в shortcut_client.py

2. При необходимости определите модели Pydantic в utils.py

3. Реализуйте функциональность MCP с помощью декораторов в server.py :

   • Используйте @mcp.resource() для ресурсов, доступных только для чтения

   • Используйте @mcp.tool() для действий, которые могут изменять данные.

   • Используйте @mcp.prompt() для генерации шаблонов или структурированного текста.

Внося вклад

Вклады приветствуются! Пожалуйста, не стесняйтесь отправлять запрос на включение.

Лицензия

Лицензия Массачусетского технологического института