Skip to main content

MCP server for Equinox documentation

Project description

equinox-mcp

MCP (Model Context Protocol) server for Equinox documentation.

Enables LLMs to access up-to-date Equinox documentation and validate generated code.

Installation

pip install equinox-mcp

Or run without installing:

uvx equinox-mcp

Usage with Claude Code

# Add as MCP server
claude mcp add -t stdio -s user equinox -- python -m equinox_mcp

# Or with uvx
claude mcp add -t stdio -s user equinox -- uvx equinox-mcp

Configuration

Environment Variable Default Description
EQUINOX_DOCS_PATH (none) Path to local Equinox docs directory (offline mode)
EQUINOX_MCP_CACHE_DIR ~/.cache/equinox-mcp Cache directory for online mode
EQUINOX_MCP_CACHE_TTL 24 Cache TTL in hours
EQUINOX_MCP_NO_CACHE 0 Set to 1 to disable caching

Offline Mode

Point to a local Equinox clone for offline access:

export EQUINOX_DOCS_PATH=/path/to/equinox/docs
python -m equinox_mcp

Online Mode (Default)

Fetches docs from GitHub with local caching:

python -m equinox_mcp
# Fetches from: raw.githubusercontent.com/patrick-kidger/equinox/main/docs/

Available Tools

Tool Description
list-sections List all available documentation sections
get-documentation Fetch specific documentation content
equinox-checker Validate Equinox module code

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

License

MIT

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

equinox_mcp-0.1.1.tar.gz (68.1 kB view details)

Uploaded Source

Built Distribution

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

equinox_mcp-0.1.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file equinox_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: equinox_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for equinox_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1181afb9fac92cd9bbedeeeaaf71535ace70588129abbbeeac76ac5413eaca6e
MD5 7a8dd10cc0531a62d186a52e48470218
BLAKE2b-256 fa68b7f37144dddf4fdffb10b6e8b278e096989ac563a98a359ab99b01a96d23

See more details on using hashes here.

File details

Details for the file equinox_mcp-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for equinox_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ee9638866235ef3aaa0d8e29cbbbc3b66f89323ff4a4a3ad16e7ee517b1c2fc
MD5 7801dc90cdf504ad5578fb972cb685fe
BLAKE2b-256 959846451c95a51753b643c1dd7f3011f8fc7d85bb40a785b236a41f7af5a2bf

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