使用说明

项目简介

Quillopy MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 提供最新的编程文档。它通过 '@quillopy' 触发，允许 LLM 在生成代码时访问实时的库、框架和工具的文档，从而避免生成过时或不准确的代码。Quillopy 预先索引了 600 多个常用库，并保持实时更新，确保 LLM 能够获取到最新的信息。

主要功能点

实时文档检索: 根据用户查询和指定的库/框架名称，从 Quillopy 的知识库中检索最新的相关文档。
工具集成: 作为一个 MCP 工具 ('quillopy_search') 注册，可以被支持 MCP 的 LLM 客户端（如 Cursor, Windsurf, Claude, Continue.dev）调用。
简化配置: 通过 'npx' 即可启动，并提供简单的配置方法，易于集成到各种 LLM 开发环境中。
零配置预索引: 内置 600+ 常用库的索引，无需用户手动上传或配置文档。
API 鉴权: 使用 API 密钥进行身份验证，确保服务安全。

安装步骤

获取 Quillopy API 密钥: 访问 https://quillopy.com 注册并获取免费的 API 密钥。这是使用 Quillopy MCP Server 的必要凭证。
安装 Quillopy MCP Server: Quillopy MCP Server 可以通过 'npx' 直接运行，无需显式安装。您只需确保您的开发环境已安装 Node.js 和 npm。

服务器配置

MCP 服务器配置 (通常在 MCP 客户端中设置) 用于告知客户端如何连接和启动 Quillopy MCP Server。以下是通用的 JSON 格式配置，您需要根据您使用的 MCP 客户端 (如 Cursor, Windsurf, Claude Desktop, Continue.dev) 的文档进行配置：

{
  "serverName": "quillopy",  // MCP 服务器的名称，客户端通过此名称引用
  "command": "npx",        // 启动服务器的命令，这里使用 npx
  "args": ["-y", "@quillopy/mcp"], // 传递给命令的参数，运行 @quillopy/mcp 包
  "env": {                 // 环境变量配置
    "QUILLOPY_API_KEY": "<your-api-key>" // 您的 Quillopy API 密钥，请替换为实际密钥
  }
}

注意:

请将 '<your-api-key>' 替换为您在 Quillopy 官网申请的 API 密钥。
不同的 MCP 客户端配置文件的位置和格式可能略有不同，请参考各客户端的 MCP 文档进行配置。
'serverName' 可以自定义，但在客户端调用时需要使用相同的名称。
'command' 和 'args' 指定了如何通过 'npx' 运行 '@quillopy/mcp' 包，从而启动 Quillopy MCP Server。

基本使用方法

在支持 MCP 的 LLM 客户端中配置 Quillopy MCP Server (参考上面的服务器配置)。
在 LLM 客户端的对话或编辑器中，使用 '@quillopy' 触发文档检索:
- 例如，提问 "How to use useState in React? @quillopy"。
- 或者，指定库名进行更精确的搜索，例如 "How to fetch data with axios? @quillopy[axios]"。
LLM 将调用 Quillopy MCP Server 的 'quillopy_search' 工具，并将检索到的文档信息作为上下文，用于生成更准确的代码或答案。

工具调用方式: 客户端通过 '@quillopy' 或 '@quillopy[文档名称]' 的形式触发 'quillopy_search' 工具，工具定义如下：

{
  "name": "quillopy_search",
  "description": "This MCP searches and fetches documentation for programming libraries, packages, and frameworks. When a user types @quillopy or @quillopy[documentation_name], they are requesting to use this tool to access programming documentation.",
  "parameters": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "description": "The search query to find specific documentation"
      },
      "documentation_name": {
        "type": "string",
        "description": "Common name to refer to the package/framework to search, e.g. sklearn"
      },
      "installation_name": {
        "type": "string",
        "description": "Name used to install the package/framework, only provide when relevant to improve search accuracy. E.g. scikit-learn for 'pip install scikit-learn'",
        "optional": true
      },
      "language": {
        "type": "string",
        "description": "The programming language of the package/framework (e.g., python, javascript, java), only provide when relevant to improve search accuracy",
        "optional": true
      }
    },
    "required": [
      "query",
      "documentation_name"
    ]
  }
}

关键词