Документация UseKeen MCP Server (Python)

Сервер MCP для API поиска документации по пакетам UseKeen, позволяющий Клоду и другим помощникам на базе искусственного интеллекта искать документацию по пакетам и службам.

Инструменты

1. usekeen_package_doc_search

   • Поиск документации по пакетам и сервисам для поиска подробностей реализации, примеров и спецификаций.

   • Требуемые входные данные:

     • package_name (строка): Имя пакета или службы, для которой нужно найти документацию (например, «react», «aws-s3», «docker»).

   • Дополнительные входные данные:

     • query (строка): поисковый запрос для поиска определенной информации в документации по пакету/услуге (например, «пример загрузки файла», «методы аутентификации»).

   • Возвращает: результаты поиска документации с соответствующими совпадениями, URL-адресами и фрагментами.

Related MCP server: UseKeen Documentation MCP Server

Настраивать

1. Получите ключ API UseKeen из сервиса UseKeen

2. Настройте среду с помощью вашего ключа API, как показано ниже.

Установка

Из PyPI

pip install usekeen-mcp

Из источника

# Clone the repository
git clone https://github.com/yourusername/usekeen-python-mcp.git
cd usekeen-python-mcp

# Install the package
pip install -e .

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

Добавьте следующее в ваш claude_desktop_config.json :

{
  "mcpServers": {
    "usekeen": {
      "command": "usekeen-mcp",
      "env": {
        "USEKEEN_API_KEY": "your_api_key_here"
      }
    }
  }
}

Использование с VS Code

Для ручной установки добавьте следующий блок JSON в файл настроек пользователя (JSON) в VS Code. Это можно сделать, нажав Ctrl + Shift + P и введя Preferences: Open Settings (JSON) .

При желании вы можете добавить его в файл .vscode/mcp.json в вашем рабочем пространстве. Это позволит вам поделиться конфигурацией с другими.

Обратите внимание, что ключ mcp не нужен в файле .vscode/mcp.json .

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "usekeen_api_key",
        "description": "UseKeen API Key",
        "password": true
      }
    ],
    "servers": {
      "usekeen": {
        "command": "usekeen-mcp",
        "env": {
          "USEKEEN_API_KEY": "${input:usekeen_api_key}"
        }
      }
    }
  }
}

Ручная настройка

Использование вспомогательных скриптов

Мы предоставляем два вспомогательных скрипта для упрощения работы сервера:

1. Местное исполнение :

   # Make the script executable (first time only)
   chmod +x scripts/run_local.sh
   
   # Run the server locally
   ./scripts/run_local.sh

2. Выполнение Docker :

   # Make the script executable (first time only)
   chmod +x scripts/run_docker.sh
   
   # Run the server in Docker
   ./scripts/run_docker.sh

Оба скрипта проверят наличие файла .env , содержащего ваш USEKEEN_API_KEY . Вы можете создать этот файл на основе предоставленного .env.example .

Работает с Python

Установите переменную среды USEKEEN_API_KEY и запустите сервер:

# Set the API key
export USEKEEN_API_KEY=your_api_key

# Run the server
python -m usekeen_mcp

Работа с Docker

Соберите и запустите Docker-контейнер с помощью ключа API:

# Build the Docker image
docker build -t usekeen-mcp .

# Run the container
docker run -e USEKEEN_API_KEY=your_api_key usekeen-mcp

Переменные среды

• USEKEEN_API_KEY : Обязательно. Ваш ключ API UseKeen для аутентификации.

Поиск неисправностей

Если вы столкнулись с ошибками, проверьте следующее:

1. Ваш ключ API UseKeen действителен и правильно настроен в вашей конфигурации.

2. У вас есть активное интернет-соединение для доступа к API UseKeen

3. В настоящее время услуга UseKeen доступна

Лицензия

Этот сервер MCP лицензирован по лицензии MIT. Это означает, что вы можете свободно использовать, изменять и распространять программное обеспечение в соответствии с условиями лицензии MIT.