金大哥 - marimo-docs-mcp MCP 详情

article

README

🚀 Marimo 文档 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 Inspector 进行调试

npm run inspector

Inspector 将提供一个可以在浏览器中访问调试工具的 URL。

🔧 技术细节

HTML 解析：使用 Cheerio 进行文档页面的 HTML 解析。
缓存机制：实现了缓存以减少文档获取请求的数量。
URL 构造：处理所有文档部分的正确 URL 构造。
递归搜索：支持文档内容的递归搜索。

📄 许可证

文档中未提及许可证相关信息。

⚠️ 重要提示

由于 MCP 服务器通过标准输入输出进行通信，调试可能会比较困难。在开发过程中，服务器会将详细的日志输出到标准错误流。

💡 使用建议

在调试时可使用 MCP Inspector 来辅助调试，它能提供一个可在浏览器中访问的调试工具 URL。

marimo-docs-mcp