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.0.tar.gz (67.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.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for equinox_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2defb328c233b2767584ede2db9b73243ce9d6b2c9012368ac00f3c475a72342
MD5 0b696a4f19417a17efcf09f1d1940652
BLAKE2b-256 b6db60b73e3db94d239aecd37672251d187d5a629939db06dcb1d360aadd97bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for equinox_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d607903ba9fc87612ef37a571102b8474804e77d0ad60b00ed42a421314894db
MD5 b84831ff282b41b17e21a9a17150c411
BLAKE2b-256 10050707ac84ab96e1a42ee4edd62064c8ae839af75b6a04211f5c222833c0d1

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