Skip to main content

MCP server for XenoDocs - Access documentation from backend.xenodocs.com

Project description

XenoDocs MCP Server

MCP (Model Context Protocol) server for accessing XenoDocs documentation from backend.xenodocs.com.

Features

  • 🔍 Search documentation across all projects
  • 📄 Retrieve specific documents by ID
  • 📁 List all available projects
  • 🔐 Secure API key authentication
  • 🚀 Runs locally in VS Code via stdio
  • ⚡ Fast async HTTP requests with httpx

Installation

Install via uvx (recommended):

uvx install xenodocs-mcp-server

Or via pip:

pip install xenodocs-mcp-server

Configuration in VS Code

Method 1: Environment Variable (Recommended)

  1. Open VS Code User Settings JSON (Ctrl+Shift+P → "Preferences: Open User Settings (JSON)")
  2. Add this configuration:
{
  "github.copilot.chat.mcp.enabled": true,
  "github.copilot.chat.mcp.servers": {
    "xenodocs": {
      "command": "uvx",
      "args": ["xenodocs-mcp-server"],
      "env": {
        "XENODOCS_API_KEY": "your-api-key-here"
      }
    }
  }
}

Method 2: Using System Environment Variables

Set your API key as a system environment variable:

Windows (PowerShell):

$env:XENODOCS_API_KEY="your-api-key-here"

Windows (CMD):

set XENODOCS_API_KEY=your-api-key-here

macOS/Linux:

export XENODOCS_API_KEY="your-api-key-here"

Then configure VS Code without the env key:

{
  "github.copilot.chat.mcp.enabled": true,
  "github.copilot.chat.mcp.servers": {
    "xenodocs": {
      "command": "uvx",
      "args": ["xenodocs-mcp-server"]
    }
  }
}

Getting Your API Key

  1. Visit XenoDocs Dashboard
  2. Navigate to SettingsAPI Keys
  3. Click Generate New API Key
  4. Copy the key and use it in your VS Code configuration

Available Tools

1. search_documentation

Search XenoDocs documentation database.

Example:

@copilot search documentation for "authentication setup"

2. get_document

Retrieve a specific document by ID.

Example:

@copilot get document with ID "doc_123456"

3. list_projects

List all available projects.

Example:

@copilot list all projects

4. get_project_docs

Get all documentation for a specific project.

Example:

@copilot get all docs for project "my-project-id"

Development

Local Setup

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

# Install dependencies
uv sync

# Or use pip
pip install -e .

# Set API key
export XENODOCS_API_KEY="your-api-key"

# Run locally
uv run xenodocs-mcp-server

Testing

Test with the MCP Inspector:

npx @modelcontextprotocol/inspector uv run xenodocs-mcp-server

Publishing to PyPI

# Build the package
uv build

# Upload to PyPI
uv publish

Troubleshooting

API Key Not Found Error

If you see:

ValueError: XENODOCS_API_KEY environment variable not set

Solution: Make sure you've configured the API key in VS Code settings or as a system environment variable.

Server Not Starting

  1. Restart VS Code completely
  2. Check that uvx is installed: uvx --version
  3. Verify the server is installed: uvx list
  4. Check VS Code Output panel for MCP logs

Permission Denied

Run VS Code with appropriate permissions or check that the uvx cache directory is writable.

Security

⚠️ Never commit your API keys!

  • Always use environment variables
  • Add .env files to .gitignore
  • Use VS Code secrets for shared workspaces
  • Rotate your API keys regularly

Support

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xenodocs_mcp_server-0.1.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xenodocs_mcp_server-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file xenodocs_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: xenodocs_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for xenodocs_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 93f93d588f9e496327140ab8c8e7e8d21327ee39d682a9aeeef277f01d4c85d6
MD5 d2e77782f79e6d61e4ec7ee0a9b829c6
BLAKE2b-256 3e560f8755a740f35b9bb9788829c6e27f9d0f9240ee718e41b8c9fc810e3329

See more details on using hashes here.

File details

Details for the file xenodocs_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for xenodocs_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 991263d098fb4a537ab42a9ed590a6a4232c26cf4f1c75e161288cb00183f0a5
MD5 745a2180325a64ca1fef9b561e3a3fbc
BLAKE2b-256 97ae446354326fe005fe1d7fac108e9b8b30f1e430c9f1f97272d02677cd413b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page