Marimo Docs MCP

🚀 Marimo 文檔 MCP 服務器

這是一個基於 TypeScript 的 MCP 服務器，它能讓你訪問 Marimo 文檔，支持搜索和瀏覽所有 API 文檔、組件、接口和示例，為開發者提供了極大的便利。

✨ 主要特性

工具

get_element_api

此工具可獲取任何 Marimo UI 元素或組件的詳細 API 文檔。

• 輸入：element (字符串) - 要獲取文檔的元素名稱（例如，“slider”、“button”）
• 輸出：結構化的 API 文檔，涵蓋以下內容：
  • 標題和描述
  • 參數及其類型和默認值
  • 代碼示例
  • 使用模式

search_api

該工具可在所有 Marimo API 文檔中進行搜索。

• 輸入：query (字符串) - 在文檔中查找的術語
• 輸出：匹配的文檔條目數組，來自任何部分

文檔部分

該服務器提供對所有 Marimo 組件的文檔訪問：

輸入

• 表單元素（button、checkbox、dropdown 等）
• 數據輸入（array、dataframe、dictionary）
• 文件處理（file、file_browser）
• 交互式元素（slider、range_slider、tabs）

佈局

• 結構化組件（accordion、sidebar、tree）
• 組織工具（callout、carousel）
• 內容管理（lazy、routes）

媒體

• 媒體元素（audio、video、image）
• 文件處理（download、pdf）
• 文本顯示（plain_text）

核心功能

• Markdown
• 控制流
• 可視化
• HTML
• 狀態管理
• 以及其他更多...

📦 安裝指南

使用 Claude 桌面版

添加到：

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

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

使用 VSCode Cline 擴展

添加到：

• MacOS: ~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
• Windows: %APPDATA%/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

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

💻 使用示例

基礎用法

# 安裝依賴
npm install

# 構建服務器
npm run build

# 帶自動重建的開發
npm run watch

📚 詳細文檔

調試

由於 MCP 服務器通過標準輸入輸出進行通信，調試可能會比較困難。在開發過程中，服務器會將詳細的日誌輸出到標準錯誤流。

您還可以使用 MCP Inspector：

npm run inspector

Inspector 將提供一個可以在瀏覽器中訪問調試工具的 URL。

錯誤處理

該服務器提供了有組織的錯誤消息，這些消息：

• 列出按部分分組的所有可用元素
• 提供無效請求的清晰反饋
• 包括適當的 HTTP 錯誤代碼

🔧 技術細節

• 使用 Cheerio 進行文檔頁面的 HTML 解析
• 實現了緩存以減少文檔獲取請求的數量
• 處理所有文檔部分的正確 URL 構造
• 支持文檔內容的遞歸搜索