UseKeen-Dokumentation MCP-Server (Python)

MCP-Server für die UseKeen Package Documentation Search API, der es Claude und anderen KI-Assistenten ermöglicht, nach Dokumentationen zu Paketen und Diensten zu suchen.

Werkzeuge

1. usekeen_package_doc_search

   • Durchsuchen Sie die Dokumentation von Paketen und Diensten, um Implementierungsdetails, Beispiele und Spezifikationen zu finden

   • Erforderliche Eingaben:

     • package_name (Zeichenfolge): Name des Pakets oder Dienstes, nach dem in der Dokumentation gesucht werden soll (z. B. „react“, „aws-s3“, „docker“)

   • Optionale Eingaben:

     • query (Zeichenfolge): Suchbegriff zum Auffinden bestimmter Informationen in der Paket-/Dienstdokumentation (z. B. „Beispiel für Dateiupload“, „Authentifizierungsmethoden“)

   • Rückgabe: Dokumentationssuchergebnisse mit relevanten Übereinstimmungen, URLs und Snippets

Related MCP server: UseKeen Documentation MCP Server

Aufstellen

1. Holen Sie sich einen UseKeen-API-Schlüssel vom UseKeen-Dienst

2. Richten Sie die Umgebung mit Ihrem API-Schlüssel wie unten gezeigt ein

Installation

Von PyPI

pip install usekeen-mcp

Aus der Quelle

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

# Install the package
pip install -e .

Verwendung mit Claude Desktop

Fügen Sie Ihrer claude_desktop_config.json Folgendes hinzu:

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

Verwendung mit VS Code

Für die manuelle Installation fügen Sie den folgenden JSON-Block zu Ihrer Benutzereinstellungsdatei (JSON) in VS Code hinzu. Drücken Sie dazu Ctrl + Shift + P und geben Sie Preferences: Open Settings (JSON) ein.

Optional können Sie es einer Datei namens .vscode/mcp.json in Ihrem Arbeitsbereich hinzufügen. Dadurch können Sie die Konfiguration mit anderen teilen.

Beachten Sie, dass der mcp Schlüssel in der Datei .vscode/mcp.json nicht benötigt wird.

{
  "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}"
        }
      }
    }
  }
}

Manuelle Einrichtung

Verwenden der Hilfsskripte

Wir stellen zwei Hilfsskripte zur Verfügung, um den Betrieb des Servers zu vereinfachen:

1. Lokale Ausführung :

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

2. Docker-Ausführung :

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

Beide Skripte suchen nach einer .env Datei, die Ihren USEKEEN_API_KEY enthält. Sie können diese Datei basierend auf dem bereitgestellten .env.example erstellen.

Ausführen mit Python

Legen Sie die Umgebungsvariable USEKEEN_API_KEY fest und führen Sie den Server aus:

# Set the API key
export USEKEEN_API_KEY=your_api_key

# Run the server
python -m usekeen_mcp

Ausführen mit Docker

Erstellen und führen Sie den Docker-Container mit dem API-Schlüssel aus:

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

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

Umgebungsvariablen

• USEKEEN_API_KEY : Erforderlich. Ihr UseKeen-API-Schlüssel zur Authentifizierung.

Fehlerbehebung

Wenn Fehler auftreten, überprüfen Sie Folgendes:

1. Ihr UseKeen-API-Schlüssel ist gültig und in Ihrer Konfiguration korrekt eingestellt

2. Sie verfügen über eine aktive Internetverbindung, um die UseKeen-API zu erreichen

3. Der UseKeen-Dienst ist derzeit verfügbar

Lizenz

Dieser MCP-Server ist unter der MIT-Lizenz lizenziert. Das bedeutet, dass Sie die Software unter den Bedingungen der MIT-Lizenz frei verwenden, ändern und verbreiten können.