Element Plus Docs MCP
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Element Plus Docs MCP show me the Button component's basic usage"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Element Plus Docs MCP
一个通过 MCP 查询 Element Plus 中文组件文档 的本地服务。
服务会实时读取官网,并在内存中缓存一小时。它提供三个工具:
list_components:列出或筛选全部组件get_component_doc:按中英文名或 slug 获取组件文档,可指定小节search_component_docs:在全部或指定组件文档中搜索关键词
环境要求
Node.js 20 或更高版本
Related MCP server: Docs-MCP
安装和构建
npm install
npm run build从源码使用时,可以将命令链接到本机:
npm link完成后可以直接运行 element-plus-docs-mcp 启动服务。
配置 MCP 客户端
在支持 stdio MCP 的客户端配置中加入:
{
"mcpServers": {
"element-plus-docs": {
"command": "element-plus-docs-mcp",
"args": []
}
}
}使用上述配置前,请先执行 npm run build && npm link。
Claude Code VS Code 扩展
Claude Code 的 VS Code 扩展可以管理已经配置的 MCP 服务。添加服务时,可以使用项目级 .mcp.json,或者在 VS Code 集成终端中写入用户级配置。
项目级配置
适合只在当前项目中使用,也可以将配置提交到版本库与团队共享。
确认本服务已经构建:
npm install npm run build npm link在需要使用 MCP 的 VS Code 项目根目录创建
.mcp.json:{ "mcpServers": { "element-plus-docs": { "type": "stdio", "command": "element-plus-docs-mcp", "args": [], "env": {} } } }在 VS Code 中执行
Developer: Reload Window,然后打开 Claude Code 聊天面板并输入/mcp。首次加载项目级 MCP 时确认授权,并检查
element-plus-docs是否显示为已连接。
用户级配置
如果希望 Claude Code VS Code 扩展在所有项目中都能使用该服务,请在 VS Code 集成终端中运行:
claude mcp add \
--transport stdio \
--scope user \
element-plus-docs \
-- element-plus-docs-mcp配置完成后,在 Claude Code 聊天面板输入 /mcp 进行查看、重连或停用。用户级 MCP 配置会同时提供给 Claude Code CLI 和 VS Code 扩展。
可以用下面的问题验证:
使用 element-plus-docs 查询 Table 组件的 span-method 用法如果连接失败,请检查:
dist/index.js是否存在;不存在时重新运行npm run build是否已经执行
npm link,并能在终端中运行element-plus-docs-mcp在 Claude Code 面板的
/mcp中尝试重新连接
工具示例
获取 Button 的基础用法:
{
"component": "button",
"section": "基础用法"
}搜索 Table 的 span-method:
{
"query": "span-method",
"components": ["table"]
}配置项
ELEMENT_PLUS_DOCS_BASE_URL:文档基础地址,默认https://cn.element-plus.org/zh-CN/componentELEMENT_PLUS_CACHE_TTL_MS:缓存时间(毫秒),默认3600000
开发
npm run dev
npm run checkAvailable Tools
3 toolsget_component_doc获取 Element Plus 组件文档A
根据组件中英文名或 slug 获取中文官网文档,结果为适合模型阅读的 Markdown。
Inputs: component (required), section, force_refresh, max_characters.
list_components列出 Element Plus 组件C
从 Element Plus 中文官网读取组件总览,可按分类或名称过滤。
Inputs: query, category, force_refresh.
search_component_docs搜索 Element Plus 组件文档A
在 Element Plus 中文组件文档中搜索关键词,返回相关组件和上下文片段。首次全库搜索需要抓取所有组件页面。
Inputs: query (required), components, max_results.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool has a clear, distinct purpose: listing components, retrieving a specific component's documentation, and searching across documentation. There is no functional overlap between the tools.
All tools follow a verb_noun pattern with snake_case, but there is a minor inconsistency in singular vs plural usage ('doc' vs 'docs'). This is a small deviation from an otherwise consistent convention.
Three tools is well-scoped for a documentation server, covering the essential actions of browse, retrieve, and search without unnecessary bloat.
The tool surface covers the core documentation needs: list components, fetch a specific doc, and search across all docs. There are no obvious gaps for its stated purpose.
Related MCP Connectors
MCP server for accessing curated awesome list documentation
MCP server for sunpeak documentation, generated by doc2mcp.
MCP server for agentverse documentation, generated by doc2mcp.
MCP server for innovationlab documentation, generated by doc2mcp.
Related MCP Servers
- AlicenseCqualityDmaintenanceA documentation server based on MCP protocol designed for various development frameworks that provides multi-threaded document crawling, local document loading, keyword searching, and document detail retrieval.348MIT
- AlicenseAqualityDmaintenanceAn MCP server that allows users to efficiently search and reference user-configured documents through document listing, grep searching, semantic searching with OpenAI Embeddings, and full document retrieval.43MIT
- AlicenseNot gradedqualityCmaintenanceProvides a local MCP server for searching and retrieving documentation from 22+ open-source projects, enabling AI coding assistants to access up-to-date docs without network dependency.9 npm3MIT
- AlicenseAqualityDmaintenanceMCP server for see-u-ui component library, allowing AI assistants to query component props/events/slots/examples on demand.311 npm1MIT