lilygo-doc-mcp
LILYGO产品文档的MCP服务器,通过模型上下文协议为LLM客户端提供结构化的硬件文档工具。文档从GitHub实时获取并在内存中缓存。
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"lilygo-docs": {
"command": "lilygo-doc-mcp",
"type": "stdio"
}
}
}
可用工具 (4 个)
该服务在 MCP 协议中暴露的工具,AI 可按需调用
list_products 3 个参数
List LILYGO products. Filter by series (e.g. 't-display-series'), tags (e.g. 'ESP32-S3,LoRa'), or keyword.
该工具无需必填参数,直接调用即可
get_product 2 个参数 需填 1 项
Get the documentation for a specific LILYGO product. Returns the full markdown or a specific section.
必填参数:product
search_products 2 个参数 需填 1 项
Full-text search across all LILYGO product documentation. Returns matching products with context excerpts.
必填参数:query
get_product_specs 1 个参数 需填 1 项
Extract structured specifications from a LILYGO product: parameters table, pin mapping, and key features.
必填参数:product
服务介绍
lilygo-doc-mcp
MCP server for LILYGO product documentation. Exposes LILYGO hardware docs as structured tools for LLM clients via the Model Context Protocol.
Documentation is fetched live from Xinyuan-LilyGO/documentation on GitHub and cached in memory for 10 minutes.
Usage
With npx (recommended)
{
"mcpServers": {
"lilygo-docs": {
"type": "stdio",
"command": "npx",
"args": ["-y", "lilygo-doc-mcp"]
}
}
}
Install globally
npm install -g lilygo-doc-mcp
{
"mcpServers": {
"lilygo-docs": {
"type": "stdio",
"command": "lilygo-doc-mcp"
}
}
}
Tools
| Tool | Description |
|---|---|
list_products |
List all products, filter by series / tags / keyword |
get_product |
Get full docs or a specific section (overview, quickstart, features, parameters, pins, faq) |
search_products |
Full-text search across all product docs with ranked excerpts |
get_product_specs |
Extract structured specs: key features, parameter table, pin tables |
Environment variables
| Variable | Default | Description |
|---|---|---|
GITHUB_RAW_BASE |
https://raw.githubusercontent.com/Xinyuan-LilyGO/documentation/master/en/products |
Base URL for fetching markdown files |
Run locally
npm install
npm run build
npm start
License
MIT