使用说明

项目简介

Needle MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为 LLM 客户端（如 Claudie Desktop）提供文档管理和强大的语义搜索能力。它通过集成 Needle AI 的服务，使用户能够轻松地组织、存储文档，并通过 Claude 等大型语言模型进行高效检索。

主要功能点

文档管理: 允许用户在服务器端组织和存储文档集合（Collection），方便快速访问和管理。
语义搜索: 集成 Needle AI 的语义搜索功能，用户可以通过自然语言查询在文档集合中进行深层搜索，找到相关信息。
与 Claude Desktop 集成: 专门设计与 Claudie Desktop 等 MCP 客户端无缝集成，通过简单的文本命令即可操作服务器功能。

安装步骤

克隆仓库:

git clone https://github.com/needle-ai/needle-mcp.git
cd needle-mcp

安装 UV: 确保已安装 UV 包管理器。根据 README 指示，推荐使用 Homebrew 安装：
```
brew install uv
```
如果 'brew' 不可用，请参考 UV 安装文档进行安装。
配置 Claude Desktop (或 MCP 客户端): 根据操作系统，找到 Claude Desktop 的配置目录，并创建或编辑 'claude_desktop_config.json' 文件。
- MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'

添加服务器配置��息: 将以下 JSON 配置添加到 'claude_desktop_config.json' 文件中的 '"mcpServers"' 字段下。请根据实际情况修改路径和API密钥。

{
  "mcpServers": {
    "needle_mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/needle-mcp",  //  替换为 Needle MCP 仓库的实际路径
        "run",
        "src/needle_mcp/server.py" //  指向服务器启动脚本
      ],
      "env": {
        "NEEDLE_API_KEY": "your_needle_api_key" // 替换为你的 Needle API 密钥
      }
    }
  }
}

配置参数说明:

'"needle_mcp"': 服务器名称，客户端用此名称识别和连接服务器。
'"command": "uv"': 启动服务器的命令，这里使用 'uv' 运行 Python 脚本。如果 'uv' 不在全局 PATH 中，需要替换为 'uv' 的完整路径 (可以使用 'which uv' 命令查找)。
'"args"': 传递给 'uv' 命令的参数列表：
- '"--directory"': 指定工作目录为 Needle MCP 仓库的根目录。
- '"/path/to/needle-mcp"': 请务必替换为 Needle MCP 仓库在您本地文件系统中的实际绝对路径。
- '"run"': 'uv run' 命令用于运行 Python 模块或脚本。
- '"src/needle_mcp/server.py"': 请务必确认服务器启动脚本 'server.py' 的路径是否正确，相对于仓库根目录。
'"env"': 设置环境变量：
- '"NEEDLE_API_KEY"': 请务必替换为你在 Needle AI 申请的 API 密钥。 这是访问 Needle AI 服务的凭证。

获取 Needle API 密钥: 访问 Needle AI 网站，注册并获取 API 密钥。
重启 MCP 客户端: 完全退出 Claudie Desktop 或其他 MCP 客户端，然后重新启动，使配置生效。

基本使用方法

配置完成后，在 Claudie Desktop 或其他 MCP 客户端中，可以使用自然语言命令与 Needle MCP 服务器交互，例如：

创建文档集合: 'Create a new collection called 'Technical Docs''
添加文档到集合: 'Add this document to the collection, which is https://needle-ai.com'
在集合中搜索: 'Search the collection for information about AI'
列出所有集合: 'List all my collections'

具体命令和用法请参考 Claudie Desktop 或您使用的 MCP 客户端的文档。

关键词

使用说明

项目简介

主要功能点

安装步骤

基本使用方法

信息