Skip to main content

A Model Context Protocol (MCP) server for accessing documentation

Project description

Docy MCP Server

A Model Context Protocol server that provides documentation access capabilities. This server enables LLMs to search and retrieve content from documentation websites by scraping them with crawl4ai. Built with FastMCP v2.

Available Tools

  • list_documentation - List all available documentation sites

    • No parameters required
  • get_doc_toc - Get the table of contents for a specific documentation site

    • doc_index (integer, required): Index of the documentation site to access
  • get_doc_page - Get a specific page from a documentation site

    • doc_index (integer, required): Index of the documentation site to access
    • url (string, required): URL of the specific documentation page to get

Prompts

  • list_docs

    • List all available documentation sites
    • No arguments required
  • doc_toc

    • Get the table of contents for a specific documentation site
    • Arguments:
      • doc_index (integer, required): Index of the documentation site to access
  • doc_page

    • Get a specific page from a documentation site
    • Arguments:
      • doc_index (integer, required): Index of the documentation site to access
      • url (string, required): URL of the specific documentation page to get

Installation

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-docy.

Using PIP

Alternatively you can install mcp-server-docy via pip:

pip install mcp-server-docy

After installation, you can run it as a script using:

DOCY_DOCUMENTATION_URLS="https://docs.python.org/3/,https://react.dev/" python -m mcp_server_docy

Using Docker

You can also use the Docker image:

docker pull oborchers/mcp-server-docy:latest
docker run -i --rm -e DOCY_DOCUMENTATION_URLS="https://docs.python.org/3/,https://react.dev/" oborchers/mcp-server-docy

Configuration

Configure for Claude.app

Add to your Claude settings:

Using uvx
"mcpServers": {
  "docy": {
    "command": "uvx",
    "args": ["mcp-server-docy"],
    "env": {
      "DOCY_DOCUMENTATION_URLS": "https://docs.python.org/3/,https://react.dev/"
    }
  }
}
Using docker
"mcpServers": {
  "docy": {
    "command": "docker",
    "args": ["run", "-i", "--rm", "oborchers/mcp-server-docy:latest"],
    "env": {
      "DOCY_DOCUMENTATION_URLS": "https://docs.python.org/3/,https://react.dev/"
    }
  }
}
Using pip installation
"mcpServers": {
  "docy": {
    "command": "python",
    "args": ["-m", "mcp_server_docy"],
    "env": {
      "DOCY_DOCUMENTATION_URLS": "https://docs.python.org/3/,https://react.dev/"
    }
  }
}

Configure for 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 User 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 needed when using the mcp.json file.

Using uvx
{
  "mcp": {
    "servers": {
      "docy": {
        "command": "uvx",
        "args": ["mcp-server-docy"],
        "env": {
          "DOCY_DOCUMENTATION_URLS": "https://docs.crawl4ai.com/,https://react.dev/"
        }
      }
    }
  }
}
Using Docker
{
  "mcp": {
    "servers": {
      "docy": {
        "command": "docker",
        "args": ["run", "-i", "--rm", "oborchers/mcp-server-docy:latest"],
        "env": {
          "DOCY_DOCUMENTATION_URLS": "https://docs.python.org/3/,https://react.dev/"
        }
      }
    }
  }
}

Configuration Options

The application can be configured using environment variables:

  • DOCY_DOCUMENTATION_URLS (string): Comma-separated list of URLs to documentation sites to include (e.g., "https://docs.python.org/3/,https://react.dev/")
  • DOCY_CACHE_TTL (integer): Cache time-to-live in seconds (default: 3600)
  • DOCY_USER_AGENT (string): Custom User-Agent string for HTTP requests
  • DOCY_DEBUG (boolean): Enable debug logging ("true", "1", "yes", or "y")
  • DOCY_SKIP_CRAWL4AI_SETUP (boolean): Skip running the crawl4ai-setup command at startup ("true", "1", "yes", or "y")

Environment variables can be set directly or via a .env file.

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

DOCY_DOCUMENTATION_URLS="https://docs.python.org/3/" npx @modelcontextprotocol/inspector uvx mcp-server-docy

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/docy
DOCY_DOCUMENTATION_URLS="https://docs.python.org/3/" npx @modelcontextprotocol/inspector uv run mcp-server-docy

Release Process

The project uses GitHub Actions for automated releases:

  1. Update the version in pyproject.toml
  2. Create a new tag with git tag vX.Y.Z (e.g., git tag v0.1.0)
  3. Push the tag with git push --tags

This will automatically:

  • Verify the version in pyproject.toml matches the tag
  • Run tests and lint checks
  • Build and publish to PyPI
  • Build and publish to Docker Hub as oborchers/mcp-server-docy:latest and oborchers/mcp-server-docy:X.Y.Z

Contributing

We encourage contributions to help expand and improve mcp-server-docy. Whether you want to add new features, enhance existing functionality, or improve documentation, your input is valuable.

For examples of other MCP servers and implementation patterns, see: https://github.com/modelcontextprotocol/servers

Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-docy even more powerful and useful.

License

mcp-server-docy 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. For more details, please see the LICENSE file in the project repository.

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

mcp_server_docy-0.1.0.tar.gz (141.0 kB view details)

Uploaded Source

Built Distribution

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

mcp_server_docy-0.1.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_server_docy-0.1.0.tar.gz
  • Upload date:
  • Size: 141.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_server_docy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b70adeec6df9cfd02866cd6035bb79e815d0d34e8b36fe29724a5e2260116e1b
MD5 4e58bf536d1653d4f681ffbe3ddb59c3
BLAKE2b-256 d61dda59fdd615561603be3bc478bffa8ea6f7781108f8e07cbb9f34489003e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_docy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7c300061bf82521d87fdcf4b76474830da8108394a788489289120ba07f4c4
MD5 04d0abeda89f42e82c45b79ccd7d7bd1
BLAKE2b-256 70089f0a1f6d1778d719ee83c6c44ff383389b87b76ce7b7da53685036f00fc4

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