Skip to main content
Glama

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

Related MCP server: Library Docs MCP Server

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

Available Tools

3 tools
equinox-checkerC

Analyze Equinox module code and suggest fixes. Checks PyTree compliance, init signature, call signature, and common mistakes.

Inputs: code (required).

get-documentationB

Retrieve full documentation for requested sections. Accepts section name(s) or path(s) like 'attention', 'api/nn/attention', or ['module', 'pattern'].

Inputs: section (required).

list-sectionsA

List all available Equinox documentation sections. Returns section titles, paths, and use cases to help identify relevant docs.

Inputs: no named parameters.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.5/5.0

    Scored across 3 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: equinox-checker analyzes code, get-documentation retrieves specific documentation, and list-sections lists available documentation sections. There is no overlap in functionality, making it easy for an agent to select the correct tool.

    Naming Consistency4/5

    The tools follow a consistent verb-noun pattern with hyphens (e.g., equinox-checker, get-documentation, list-sections), which is readable and predictable. The minor deviation is that equinox-checker includes a prefix, but overall naming is coherent.

    Tool Count4/5

    With 3 tools, the server is well-scoped for its purpose of analyzing Equinox code and accessing documentation. This count is reasonable, though slightly on the lower side, as it covers core workflows without being overwhelming.

    Completeness4/5

    The tools provide good coverage for code analysis and documentation retrieval in the Equinox domain. Minor gaps might exist, such as no direct tool for generating code or handling advanced debugging, but the set supports common agent tasks effectively.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers