Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Equinox MCP ServerExplain how to use equinox.Module and check my code."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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-mcpOr run without installing:
uvx equinox-mcpUsage 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-mcpConfiguration
Environment Variable | Default | Description |
| (none) | Path to local Equinox docs directory (offline mode) |
|
| Cache directory for online mode |
|
| Cache TTL in hours |
|
| Set to |
Offline Mode
Point to a local Equinox clone for offline access:
export EQUINOX_DOCS_PATH=/path/to/equinox/docs
python -m equinox_mcpOnline 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 all available documentation sections |
| Fetch specific documentation content |
| Validate Equinox module code |
Development
# Install dev dependencies
pip install -e ".[dev]"
# Run tests
pytestLicense
MIT