Jira Weekly Reporter MCP Server

Jira Weekly Reporter MCP-сервер

Этот проект предоставляет сервер FastMCP , который подключается к вашему экземпляру Jira (облако или сервер/центр обработки данных) для создания еженедельных отчетов на основе активности по проблемам. Он использует библиотеку pycontribs-jira для взаимодействия с Jira и может опционально использовать Large Language Model (LLM) подключенного клиента для резюмирования сгенерированного отчета.

✨ Особенности

• Подключение к Jira: безопасное подключение к Jira с использованием токенов API, хранящихся в файле .env .
• Инструмент MCP: предоставляет инструмент generate_jira_report , доступный через протокол контекста модели.
• Гибкая отчетность:
  • По умолчанию сообщения о проблемах обновляются за последние 7 дней.
  • Позволяет указать пользовательский JQL-запрос.
  • Возможность фильтровать отчеты по определенному ключу проекта Jira.
  • Ограничивает количество возвращаемых результатов (настраивается).
• (Необязательно) Резюме LLM: можно использовать LLM клиента (через ctx.sample() ) для предоставления краткого резюме отчета.
• Асинхронная обработка: правильно обрабатывает синхронные вызовы библиотеки Jira на асинхронном сервере FastMCP с помощью asyncio.to_thread .

📋 Предварительные условия

• Python 3.10 или более поздняя версия.
• uv (рекомендуется) или pip для управления пакетами.
• Доступ к экземпляру Jira (облако, сервер или центр обработки данных).
• Токен API Jira (персональный токен доступа для сервера/DC).
• FastMCP CLI установлен и доступен в PATH вашей системы.

⚙️ Настройка

1. Клонируйте репозиторий (если применимо):
   git clone https://github.com/Jongryong/jira_reporter.git cd jira_reporter
2. Установка зависимостей: Мы рекомендуем использовать uv :
   uv pip install fastmcp "jira[cli]" python-dotenv httpx anyio
   В качестве альтернативы можно использовать pip :
   pip install fastmcp "jira[cli]" python-dotenv httpx anyio
3. Создайте файл .env : Создайте файл с именем .env в том же каталоге, что и jira_reporter_server.py . Добавьте данные о подключении к Jira:
   # .env JIRA_URL=https://your-domain.atlassian.net # Your Jira Cloud URL or Self-Hosted URL JIRA_USERNAME=your_email@example.com # Your Jira login email JIRA_API_TOKEN=your_api_token_or_pat # Your generated API Token or PAT
   • Безопасность:
     • Никогда не передавайте файл .env в систему контроля версий! Добавьте .env в файл .gitignore .
     • Jira Cloud: создайте токен API из настроек вашего аккаунта Atlassian: Управление токенами API .
     • Сервер/центр обработки данных Jira: создайте персональный токен доступа (PAT) из настроек профиля пользователя Jira: Использование персональных токенов доступа .

▶️ Запуск сервера (автономный)

Вы можете запустить сервер независимо для тестирования или других целей:

1. Напрямую с помощью Python:
   python jira_reporter_server.py
2. Использование FastMCP CLI:
   fastmcp run jira_reporter_server.py
   Для запуска с SSE (например, для удаленного доступа):
   fastmcp run jira_reporter_server.py --transport sse --port 8001

🖥️ Использование с Claude Desktop

Чтобы сделать этот сервер доступным как инструмент в приложении Claude Desktop:

1. Убедитесь, что выполнены предварительные условия: убедитесь, что fastmcp установлен и доступен в PATH вашей системы, так как в приведенной ниже конфигурации используется команда fastmcp .
2. Найдите файл конфигурации Claude: Найдите файл claude_desktop_config.json . Его местоположение зависит от вашей операционной системы:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json (обычно C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json )
   • Linux: ~/.config/Claude/claude_desktop_config.json (или $XDG_CONFIG_HOME/Claude/ )
3. Отредактируйте файл конфигурации: Откройте claude_desktop_config.json в текстовом редакторе.
4. Добавьте конфигурацию сервера: найдите объект "mcpServers" в JSON (если он не существует, создайте его как пустой объект {} ). Добавьте следующую запись в mcpServers , обязательно заменив "path/to/your/jira_reporter_server.py" на абсолютный путь к вашему скрипту:
   { "mcpServers": { // ... other servers might be here ... "jira_report": { "command": "fastmcp", "args": [ "run", "/path/to/your/jira_reporter_server.py" // <-- IMPORTANT: Use the full, absolute path here ] } // ... other servers might be here ... } // ... rest of your Claude config ... }
   • "jira_report" : Это внутреннее имя, которое использует Клод. Вы можете изменить его, если хотите.
   • "command": "fastmcp" : сообщает Клоду, что нужно использовать инструмент командной строки fastmcp .
   • "args": [...] : сообщает Клоду о необходимости запустить fastmcp run /path/to/your/jira_reporter_server.py .
5. Сохраните и перезапустите: сохраните файл claude_desktop_config.json и перезапустите приложение Claude Desktop.
6. Вызовите инструмент: Теперь вы сможете использовать инструмент в Claude, упомянув имя сервера, определенное в скрипте Python ( Jira Weekly Reporter ). Например: @Jira Weekly Reporter generate jira report for project MYPROJ and summarize it

🛠️ Подробности об инструменте MCP

• Название инструмента: generate_jira_report
• Описание: Формирует отчет о проблемах Jira на основе запроса JQL (по умолчанию — недавно обновленный). При желании суммирует отчет с использованием LLM клиента.

Параметры:

📦 Зависимости сервера

Конструктор FastMCP включает dependencies=["jira"] . Это сообщает таким инструментам, как fastmcp install , что библиотека jira необходима для корректной работы этого сервера при создании изолированных сред.

🤝 Вклад

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

📄 Лицензия

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