UseKeen Documentation MCP Server

MCP Server for the UseKeen Package Documentation Search API, enabling Claude and other AI assistants to discover packages and search their documentation.

Tools

1. usekeen_package_search

• New! Search for packages by name or description to discover relevant packages
• Required inputs:
  • query (string): Search query to find relevant packages (e.g. 'web framework', 'authentication', 'database orm')
• Optional inputs:
  • max_results (number): Maximum number of packages to return (1-100, default: 10)
• Returns: List of matching packages with metadata including names, descriptions, and versions

2. usekeen_package_doc_search

• Search documentation of packages and services to find implementation details, examples, and specifications
• Required inputs:
  • package_name (string): Name of the package or service to search documentation for (e.g. 'react', 'aws-s3', 'docker')
• Optional inputs:
  • query (string): Search term to find specific information within the package/service documentation (e.g. 'file upload example', 'authentication methods')
• Returns: Documentation search results with relevant matches, URLs, and snippets

Workflow

The tools work together to provide a complete package discovery and documentation search experience:

1. Discovery: Use usekeen_package_search to find packages related to your needs
2. Deep Dive: Use usekeen_package_doc_search to search within a specific package's documentation

Example workflow:

1. Search for packages: usekeen_package_search(query="web framework")
2. Find a relevant package (e.g., "express")
3. Search its documentation: usekeen_package_doc_search(package_name="express", query="middleware")

Prerequisites

1. UseKeen API Key: Get a UseKeen API key from the UseKeen service
2. Node.js (for NPX installation) or Docker (for Docker installation)
3. Claude Desktop or VS Code with MCP extension

Installation

Option 1: NPX (Recommended)

The easiest way to use this MCP server is via NPX:

npx usekeen-mcp

Option 2: Docker

You can also run the server using Docker:

docker run -e USEKEEN_API_KEY=your_api_key_here mcp/usekeen

Option 3: Local Development

For local development or manual installation:

# Clone the repository
git clone <repository-url>
cd usekeen-mcp

# Copy environment file and add your API key
cp .env.example .env
# Edit .env and add your USEKEEN_API_KEY

# Install dependencies
npm install

# Build and run
npm run build
npm start

Configuration

Usage with Claude Desktop

Add the following to your claude_desktop_config.json:

NPX

{
  "mcpServers": {
    "usekeen": {
      "command": "npx",
      "args": [
        "-y",
        "usekeen-mcp"
      ],
      "env": {
        "USEKEEN_API_KEY": "your_api_key_here"
      }
    }
  }
}

Docker

{
  "mcpServers": {
    "usekeen": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "USEKEEN_API_KEY",
        "mcp/usekeen"
      ],
      "env": {
        "USEKEEN_API_KEY": "your_api_key_here"
      }
    }
  }
}

Usage with VS Code

For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is not needed in the .vscode/mcp.json file.

NPX

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

Docker

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

Manual Setup

Using the Helper Scripts

We provide two helper scripts to make it easier to run the server:

1. Local Execution:

   # Make the script executable (first time only)
   chmod +x run-local.sh
   
   # Run the server locally
   ./run-local.sh

2. Docker Execution:

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

Both scripts will check for a .env file containing your USEKEEN_API_KEY. You can create this file based on the provided .env.example.

Running with npm

Set the USEKEEN_API_KEY environment variable and run the server:

# Install dependencies
npm install

# Build the TypeScript code
npm run build

# Run the server
USEKEEN_API_KEY=your_api_key npm start

Running with Docker

Build and run the Docker container with the API key:

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

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

Environment Variables

• USEKEEN_API_KEY: Required. Your UseKeen API key for authentication.

Troubleshooting

If you encounter errors, verify that:

1. Your UseKeen API key is valid and correctly set in your configuration
2. You have an active internet connection to reach the UseKeen API
3. The UseKeen service is currently available

Build

Docker build:

docker build -t mcp/usekeen .

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License.