关键词

Svelte 5文档搜索语义搜索OpenAI Retrieval API知识库

项目简介

本项目 'mcp-svelte-docs' 是一个实现了 Model Context Protocol (MCP) 协议的服务器，专门用于提供 Svelte 5 框架文档的语义搜索功能。它利用 OpenAI 的 Retrieval API 构建了一个向量数据库，存储了完整的 Svelte 5 官方文档。通过此 MCP 服务器，LLM 应用（如 Claude、Cursor 等）可以调用 'search_svelte_docs' 工具，使用自然语言查询 Svelte 5 文档，获取精准的答案和代码示例，从而提高开发效率和代码质量。

主要功能点

  • Svelte 5 文档语义搜索: 支持使用自然语言查询 Svelte 5 官方文档，摆脱关键词搜索的限制，更精准地找到所需信息。
  • 自动文档同步: 服务器能够自动下载最新的 Svelte 5 文档并更新向量数据库，保证搜索结果的时效性。
  • 集成 OpenAI Retrieval API: 利用 OpenAI 强大的语义搜索能力，提供高质量的搜索结果。
  • 支持 MCP 协议: 遵循 MCP 协议标准，可以方便地集成到各种支持 MCP 协议的 LLM 客户端。
  • 工具注册与调用: 提供 'search_svelte_docs' 工具，供 LLM 客户端调用，实现文档搜索功能。

安装步骤

  1. 安装 Node.js: 确保你的环境中安装了 Node.js 16 或更高版本。
  2. 全局安装 'mcp-svelte-docs': 打开终端，运行以下命令进行全局安装： 
    npm install -g @ronangrant/mcp-svelte-docs
    或者使用 'npx' 直接运行： 
    npx @ronangrant/mcp-svelte-docs
  3. 设置 OpenAI API Key: 你需要拥有 OpenAI API Key，并确保你的账号有 Retrieval API 的访问权限。可以通过环境变量或命令行参数的方式提供 API Key。

服务器配置

为了让 MCP 客户端（如 Claude Desktop, Cursor 等）连接到 'mcp-svelte-docs' 服务器，你需要配置客户端的 MCP 服务器设置。以下是通用的配置信息，以 JSON 格式提供，你需要根据你的 MCP 客户端进行相应的配置：

{
  "serverName": "svelte5docs",  //  MCP 服务器名称，可以自定义
  "command": "npx",             //  启动服务器的命令，这里使用 npx
  "args": [                     //  传递给命令的参数
    "-y",                       //  npx 参数，自动确认执行
    "@ronangrant/mcp-svelte-docs" //  要执行的 npm 包名，即 mcp-svelte-docs 服务器
  ],
  "env": {                       //  环境变量配置
    "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"  //  你的 OpenAI API Key，请替换为你的实际 Key
  }
}

配置说明:

  • 'serverName': MCP 服务器的名称，客户端用此名称来标识和调用该服务器，可以自定义。
  • 'command': 启动 MCP 服务器的命令。由于我们全局安装了 '@ronangrant/mcp-svelte-docs'，或者希望直接使用 'npx' 运行，所以这里设置为 'npx'。
  • 'args': 传递给 'command' 的参数。
    • '"-y"': 'npx' 的参数，表示自动确认执行，避免交互式提示。
    • '"@ronangrant/mcp-svelte-docs"': 指定要通过 'npx' 运行的 npm 包，即我们的 MCP 服务器。
  • 'env': 环境变量配置。
    • '"OPENAI_API_KEY"': 必须配置，用于提供访问 OpenAI API 的密钥。请将 '"YOUR_OPENAI_API_KEY"' 替换为你实际的 OpenAI API Key。

不同 MCP 客户端的配置方法：

  • Cursor: Cursor 提供了添加 MCP Tool 的功能。你可以使用命令 'npx -y @ronangrant/mcp-svelte-docs --openai-api-key=YOUR_OPENAI_API_KEY' 快速添加工具。更详细的配置规则可以在 Cursor 的 "New Cursor Rule" 中设置，以便在特定场景下自动调用该 MCP 工具。
  • Claude Desktop: 需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'，将上述 JSON 配置添加到 'mcpServers' 字段中。配置文件路径通常为：
    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • 其他 MCP 客户端: 请参考对应客户端的文档，查找如何配置外部 MCP 服务器，并根据上述 JSON 配置信息进行配置。通常需要提供服务器启动命令、参数以及环境变量。

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端中，你可以通过调用 'search_svelte_docs' 工具来搜索 Svelte 5 文档。

工具名称: 'search_svelte_docs'

参数:

  • 'query' (必填, 字符串): 搜索查询语句，即你想搜索的 Svelte 5 相关问题或关键词。
  • 'limit' (可选, 数字, 默认值: 5): 返回结果的最大数量。

使用示例 (在 LLM 客户端中提示词中指示):

使用 search_svelte_docs 工具搜索 "Svelte 5 中 реактивность (reactivity) 的工作原理"，返回最多 3 个结果。

LLM 客户端会将上述指令转换为 MCP 请求，调用 'mcp-svelte-docs' 服务器的 'search_svelte_docs' 工具，并将搜索结果返回给你。你将在 LLM 的回复中看到 Svelte 5 文档的搜索结果。

信息

分类

AI与计算

访问项目