知识库检索服务器

一个实现模型上下文协议(MCP)的服务器,用于从Ragie知识库中检索相关信息。

  • by ragieai
  • JavaScript
  • 本地部署
  • 91 星标
  • 更新于
在 GitHub 查看 ragieai/ragie-mcp-server

使用说明

重要!

不再需要此项目.Ragie现在原生支持MCP作为可流式传输的HTTP服务器。请参阅此处的文档:[https://docs.ragie.ai/docs/mcp-overview]

如果您希望公司内的用户能够在Claude或ChatGPT等应用程序中访问您的知识库,您可能需要 MCP电桥

Ragie模型上下文协议服务器

一种模型上下文协议(MCP)服务器,提供对Ragie知识库检索功能的访问。

描述

该服务器实现了模型上下文协议,使AI模型能够从Ragie知识库中检索信息。它提供了一个名为“检索”的单一工具,允许查询知识库中的相关信息。

先决条件

  • Node.js>=18
  • 愤怒的API密钥

安装

服务器需要以下环境变量:

  • RAGIE_API_KEY (必需):您的Ragie API身份验证密钥

服务器将启动并在stdio上监听MCP协议消息。

使用npx安装并运行服务器:

RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server

命令行选项

服务器支持以下命令行选项:

  • --description, -d <text>:用自定义文本覆盖默认工具描述
  • --partition, -p <id>:指定要查询的Ragie分区ID

示例:

# With custom description
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base for information"

# With partition specified
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

# Using both options
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base" --partition your_partition_id

光标配置

要将此MCP服务器与Cursor一起使用,请执行以下操作:

选项1:创建MCP配置文件

  1. 保存一个名为的文件 mcp.json
  • 用于特定于项目的工具,创建一个 .cursor/mcp.json 项目目录中的文件。这允许您定义仅在特定项目中可用的MCP服务器。
  • 用于您希望在所有项目中使用的工具,创建一个 ~/.cursor/mcp.json 将文件放在主目录中。这使得MCP服务器在所有Cursor工作区中都可用。

示例 mcp.json:

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

选项2:使用shell脚本

  1. 保存一个名为的文件 ragie-mcp.sh 在您的系统上:
#!/usr/bin/env bash

export RAGIE_API_KEY="your_api_key"

npx -y @ragieai/mcp-server --partition optional_partition_id
  1. 授予文件执行权限: chmod +x ragie-mcp.sh

  2. 通过转到添加MCP服务器脚本 设置 -> 光标设置 -> MCP服务器 在光标UI中。

替换 your_api_key 使用实际的Ragie API密钥,并根据需要设置分区ID。

Claude桌面配置

要在Claude桌面上使用此MCP服务器,请执行以下操作:

  1. 创建MCP配置文件 claude_desktop_config.json:
  • 对于MacOS:使用 ~/Library/Application Support/Claude/claude_desktop_config.json
  • 对于Windows:使用 %APPDATA%/Claude/claude_desktop_config.json

示例 claude_desktop_config.json:

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

替换 your_api_key 使用实际的Ragie API密钥,并根据需要设置分区ID。

  1. 重新启动Claude桌面以使更改生效。

Ragie检索工具现在将在您的Claude桌面对话中可用。

特性

选择刀具

服务器提供 retrieve 可用于搜索知识库的工具。它接受以下参数:

  • query (string):查找相关信息的搜索查询
  • topK (number,可选,默认值:8):返回的最大结果数
  • rerank (boolean,可选,默认值:true):是否尝试只查找最相关的信息
  • recencyBias (布尔值,可选,默认值:false):是否偏向于结果而非最新信息

工具返回:

  • 包含知识库中匹配文本的内容块数组

发展

此项目使用TypeScript编写,并使用以下主要依赖项:

  • @modelcontextprotocol/sdk:用于实现MCP服务器
  • ragie:用于与Ragie API交互
  • zod:用于运行时类型验证

开发设置

在开发模式下运行服务器:

RAGIE_API_KEY=your_api_key npm run dev -- --partition optional_partition_id

建设项目:

npm run build

许可证

MIT许可证-详情请参阅License.txt。