使用说明

项目简介

Weaverse MCP服务器是一个基于Model Context Protocol (MCP) 的后端服务，专为LLM（大型语言模型）客户端设计。它通过提供search_docs工具，使得LLM能够便捷地搜索和访问Weaverse官方文档内容，从而增强LLM在Weaverse相关领域的知识和应用能力。

主要功能点

文档搜索工具 (search_docs): 提供根据用户查询关键词搜索Weaverse官方文档的功能。
MCP服务器实现: 遵循MCP协议标准，可以与任何兼容MCP协议的LLM客户端（如Cursor、Claude Desktop等）无缝集成。
标准JSON-RPC通信: 使用JSON-RPC协议与客户端通信，保证了交互的标准化和通用性。
Stdio传输协议: 通过标准输入输出 (stdio) 与客户端建立连接，简化部署和运行。

安装步骤

使用 npx 运行: 无需额外安装，即可通过 npx 命令直接运行 Weaverse MCP 服务器。
```
npx -y @weaverse/mcp@latest
```

服务器配置

对于需要配置MCP服务器的LLM客户端（例如 Cursor 或 Claude Desktop），您需要添加以下JSON配置信息。这些配置信息告诉客户端如何启动和连接到 Weaverse MCP 服务器。

{
  "mcpServers": {
    "weaverse-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@weaverse/mcp"
      ]
    }
  }
}

配置参数说明:

'"weaverse-mcp"': 服务器名称，可以自定义，用于在客户端中标识该服务器。
'"command": "npx"': 启动服务器的命令。'npx' 允许您直接运行 npm 包，无需全局安装。
'"args": ["-y", "@weaverse/mcp"]': 传递给 'npx' 命令的参数。
- '"-y"': 自动确认 npx 的安装提示。
- '"@weaverse/mcp"': 指定要运行的 npm 包为 '@weaverse/mcp'，即 Weaverse MCP 服务器。

请注意: 您只需将以上 JSON 配置添加到您的 MCP 客户端配置中，无需手动配置服务器端。服务器通过 'npx' 命令启动并自动运行。

基本使用方法

启动 MCP 服务器: 在终端中运行 'npx -y @weaverse/mcp@latest' 命令，启动 Weaverse MCP 服务器。服务器将在后台运行，并通过 stdio 等待客户端连接。
配置 MCP 客户端: 在您的 MCP 客户端（如 Cursor 或 Claude Desktop）中，添加上述提供的服务器配置 JSON。
调用工具: 在您的 LLM 客户端中，当需要搜索 Weaverse 文档时，可以使用 'search_docs' 工具。客户端会向 Weaverse MCP 服务器发送请求，服务器将执行文档搜索并返回结果给客户端。
在 LLM 中使用: 您可以在与 LLM 的对话中，指示 LLM 使用 'search_docs' 工具来查询 Weaverse 文档。例如，您可以提问类似 "Weaverse 中如何添加自定义组件？" 的问题，LLM 可能会自动调用 'search_docs' 工具来辅助回答。

关键词