使用说明
Vue Prime MCP服务器
通过模型上下文协议访问PrimeVue文档的MCP服务器。
机会
服务器提供对PrimeVue文档的三个主要终端的访问:
/llms.txt-结构化的关键文档页面列表(帮助AI模型的行业标准)/llms-full.txt-完整的PrimeVue文档和所有页面/components/{component}.md-特定组件的Markdown文档
资源
primevue://llms-txt-结构化的关键页面列表https://primevue.org/llms/llms.txtprimevue://llms-full-txt-完整的文档来自https://primevue.org/llms/llms-full.txtprimevue://component/{componentName}-组件文档https://primevue.org/llms/components/{component}.md
工具
get-primevue-component
获取Markdown格式的特定PrimeVue组件文档。
参数:
componentName(string)-小写组件名称(例如:“menu”、“button”、“datable”)
例子:
{
"componentName": "menu"
}
Endpoint: https://primevue.org/llms/components/menu.md
get-primevue-llms-txt
获取PrimeVue文档关键页面的结构化列表。
参数: 不
Endpoint: https://primevue.org/llms/llms.txt
get-primevue-llms-full-txt
获取完整的PrimeVue文档。
参数: 不
Endpoint: https://primevue.org/llms/llms-full.txt
search-primevue-docs
在完整的PrimeVue文档中查找有关关键字或短语的信息。
参数:
query(string)-搜索请求
例子:
{
"query": "Button component"
}
促销
primevue-help
创建PROMPT以获得PrimeVue的帮助。
参数:
topic(string,可选)-特定主题或问题
安装
pnpm install
装配
pnpm run build
发射
开发
pnpm run dev
制作
pnpm start
与MCP客户端一起使用
操作模式:HTTP(网络)
服务器作为HTTP服务器运行,并在端口3000(默认情况下)上通过网络提供。
快速启动
-
建立依赖关系并收集项目:
pnpm install pnpm run build -
启动服务器:
pnpm start # или для разработки pnpm run dev -
检查工作:
curl http://localhost:3000/health -
连接MCP客户端 (见下文说明)
Claude 桌面 (HTTP 模式)
Linux
-
创建或打开配置文件:
mkdir -p ~/.config/Claude nano ~/.config/Claude/claude_desktop_config.json -
添加配置:
{ "mcpServers": { "vue-prime-mcp": { "url": "http://localhost:3000/mcp" } } } -
验证服务器是否已启动并重新启动Claude Desktop
macOS
-
创建或打开配置文件:
mkdir -p ~/Library/Application\ Support/Claude open ~/Library/Application\ Support/Claude/claude_desktop_config.json -
添加配置:
{ "mcpServers": { "vue-prime-mcp": { "url": "http://localhost:3000/mcp" } } } -
验证服务器是否已启动并重新启动Claude Desktop
视窗
-
打开配置文件:
%APPDATA%\Claude\claude_desktop_config.json -
添加配置:
{ "mcpServers": { "vue-prime-mcp": { "url": "http://localhost:3000/mcp" } } } -
验证服务器是否已启动并重新启动Claude Desktop
远程连接
如果服务器在另一台计算机上运行,请使用IP地址:
{
"mcpServers": {
"vue-prime-mcp": {
"url": "http://192.168.1.100:3000/mcp"
}
}
}
配置端口和主机
通过环境变量更改端口和主机:
PORT=8080 HOST=0.0.0.0 pnpm start
端点
POST /mcp用于Streamable HTTP的MCP EndpointGET /mcp-服务器信息(用于获取请求)GET /health-健康检查端点GET /-有关服务器和可用资源/工具的信息
详细说明: 见E/CN.4/Sub.2/2000/SR.1。文件 连接.md
曲名:PrimeVue
服务器使用以下官方PrimeVue Endpoint:
- llms.txt:
https://primevue.org/llms/llms.txt-AI模型的结构化关键页面列表 - llms-full.txt:
https://primevue.org/llms/llms-full.txt-完整的文件 - 组件Markdown:
https://primevue.org/llms/components/{component}.md-Markdown组件文档
增编 .md 页面的URL返回该页面的Markdown版本。
缓存
服务器缓存下载的文档以快速访问:
llms.txt首次下载后缓存llms-full.txt首次下载后缓存- 组件文档单独缓存
开发
该项目使用TypeScript并编译为JavaScript。源代码在 src/,编译代码-B dist/.
关于Vercel
该项目已准备好在Vercel上发布。关于详细说明,见附件一。在 VERCEL.md.
快板
# Установите Vercel CLI
npm i -g vercel
# Войдите
vercel login
# Деплой
vercel --prod
在Deploy之后,Endpoints将在以下地址提供:
https://your-project.vercel.app/api/mcp主要MCP Endpointhttps://your-project.vercel.app/api/health-健康检查
备注: 服务器使用无状态模式-每个请求都是独立的,不需要会话。
许可证
麻省理工学院
