Stimulus Docs

You can run an MCP server that exposes up-to-date Stimulus documentation through your MCP client. This server caches content locally, fetches fresh material from the Stimulus repository when available, and falls back to local copies if needed. It also provides an executable you can run locally after building from source, letting you access handbook and reference content inside your MCP client.

How to use

To access Stimulus documentation through your MCP client, first ensure your server is built and running. You will configure your MCP client to connect to the Stimulus Docs MCP server, which exposes documentation content as separate tools you can invoke from your conversations or editor integrations.

How to install

Prerequisites include a modern Node.js runtime and npm. Install and build the MCP server with these steps.

# Prerequisite: ensure Node.js >= 18.0.0 is installed on your system
node -v
npm -v

# 1. Install dependencies
npm install

# 2. Build the project
npm run build
```} ]},{

After building, you will have an executable in the build/ directory that runs the MCP server locally.

Additional notes

Usage with your MCP client requires configuring the client to connect to the local or remote MCP server. The project provides two common configuration patterns: a local stdio-based server and a simple Node.js-based server invocation.

Practical usage patterns include starting the server locally and pointing the MCP client to the appropriate command, either directly through a stdio configuration or via a node-based execution path.

If you encounter issues starting the server, verify that the node executable is accessible in your environment. Providing a full path to the node binary often resolves ENOENT errors.

Available tools

Handbook: The Origin of Stimulus

Accesses the early material that introduces Stimulus concepts and the overarching design philosophy.

Handbook: Introduction

Provides an overview of Stimulus, its philosophy, and how to start using it in projects.

Handbook: Hello Stimulus Tutorial

Step-by-step tutorial to create a simple Stimulus application and wire up controllers, targets, and actions.

Handbook: Building Something Real

Guides you through building a practical Stimulus-powered feature from start to finish.

Handbook: Designing for Resilience

Discusses patterns for robustStimulus applications, including error handling and graceful degradation.

Handbook: Managing State

Explains strategies for managing UI state with Stimulus controllers and targets.

Handbook: Working with External Resources

Covers integrating Stimulus with external APIs, assets, and services.

Handbook: Installing Stimulus

Instructions for adding Stimulus to various project setups and frameworks.

Reference: Actions

Details how to declare actions in HTML and wire them to controller methods.

Reference: Controllers

Describes the controller lifecycle, structure, and how to organize behavior.

Reference: CSS Classes

Shows how to group and use CSS classes in conjunction with Stimulus.

Reference: Lifecycle Callbacks

Outlines lifecycle hooks and when Stimulus runs actions during a lifecycle.

Reference: Outlets

Explains how to expose and use outlets to interact with DOM elements.

Reference: Targets

Covers how to define and reference targets within controllers.

Reference: Using TypeScript

Guidance for using Stimulus with TypeScript, including types and setup tips.

Reference: Values

Details how to declare and use values to store and retrieve data in controllers.