stimulus-docs

This MCP server provides on-demand access to up-to-date Stimulus JS documentation. It fetches content from the official Stimulus-site repository and caches it locally to improve performance and reliability. The server exposes a collection of tools corresponding to different sections of the Stimulus documentation, such as the Handbook and the Reference. Each tool lets you retrieve relevant documentation content, with a caching and fallback strategy so you can access information even if GitHub is temporarily unavailable.

Prerequisites

• Node.js 18.0.0 or higher
• npm (bundled with Node.js)

Installation steps

1. Clone the repository and navigate to the project directory
2. Install dependencies

npm install

3. Build the project

npm run build

4. Run the built MCP server (adjust the path as needed)

node build/index.js

5. Add the MCP server to Claude Desktop or your MCP client configuration as shown in the README (the example uses the built index.js path):

{
  "mcpServers": {
    "stimulus-docs": {
      "command": "node",
      "args": ["/path/to/your/stimulus-docs-mcp-server/build/index.js"],
      "env": {}
    }
  }
}

Notes

• If your environment cannot locate node, supply the full path to the node executable in the command.
• The server fetches latest Stimulus documentation from GitHub and caches content under a commit-based cache structure for fast retrieval.

Tips and caveats:

• Prerelease/experimental status: This MCP is experimental; expect changes and possible instability.
• Caching strategy: The server caches content per commit SHA and timestamp to minimize API calls. Ensure sufficient disk space for caches.
• Environment variables: You may want to provide environment variables for custom cache paths or GitHub access if needed in your deployment environment.
• Troubleshooting: If you see ENOENT errors (node not found), use the full path to the Node executable in the command.
• Documentation coverage: Available tools include sections from Handbook (Origin of Stimulus, Introduction, Hello Stimulus Tutorial, Building Something Real, Designing for Resilience, Managing State, Working with External Resources, Installing Stimulus) and Reference (Actions, Controllers, CSS Classes, Lifecycle Callbacks, Outlets, Targets, Using TypeScript, Values).