Marimo Documenation

Provides access to Marimo API documentation, including components, interfaces, and examples, via MCP.

typescript

11

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "stevenbtw-marimo-docs-mcp": {
      "command": "node",
      "args": [
        "/path/to/marimo-docs/build/index.js"
      ]
    }
  }
}

You run a Marimo MCP Server to access and search Marimo’s API documentation programmatically. Through this server, you can fetch detailed API info for UI elements and perform comprehensive searches across all documentation sections, enabling fast discovery and integration into your tooling.

How to use

You interact with the Marimo MCP Server from your MCP client. The server exposes two core capabilities: fetching element-specific API documentation and performing full-text searches across the docs. Use get_element_api to retrieve detailed information for a specific UI element or component, including titles, descriptions, parameters, code examples, and usage patterns. Use search_api to locate relevant documentation entries by providing a search term. The server is designed to deliver structured data that you can render in your tooling or IDE integrations.

How to install

Prerequisites you need on your machine: a modern Node.js runtime and npm. Ensure you have a working shell and permission to install dependencies.

Step 1: Install dependencies

npm install

Step 2: Build the server

npm run build

Step 3: Development with auto-rebuild (optional)

npm run watch

Step 4: Start the server (production/normal development) if you want to run it locally

node build/index.js

Configuration examples for MCP integration with common environments are provided for desktop and editor integrations. You can adapt these snippets to your setup.

Configuration and usage examples

Integration snippets show how to wire the MCP server into your environment. They illustrate how to reference the built server binary or entry script in your MCP client. Use the following example configurations as starting points.

{
  "mcpServers": {
    "marimo_docs": {
      "command": "/path/to/marimo-docs/build/index.js"
    }
  }
}

Available tools

get_element_api

Fetches detailed API documentation for a specific Marimo UI element or component, including title, description, parameters with types and defaults, code examples, and usage patterns.

search_api

Searches across all Marimo API documentation and returns an array of matching entries from any section.