关键词

知识库查询上下文服务AtherOSOnyx API聊天会话

使用说明

项目简介

Context Bank MCP 项目基于 Model Context Protocol (MCP) 构建，旨在为 LLM 客户端提供一个接口，通过 Onyx API 查询 AtherOS 知识库。它作为一个 MCP 服务器，允许客户端创建聊天会话并在会话中发送查询，从而获取知识库的答案和相关上下文信息。

主要功能点

  • 创建聊天会话: 允许客户端创建新的聊天会话，用于与 AtherOS 知识库进行交互。
  • 查询知识库: 允许客户端在已创建的聊天会话中发送消息，查询 AtherOS 知识库并获取答案。
  • 格式化响应: 服务器会将从 Onyx API 获取的响应进行格式化处理，使其更易于理解和使用，包括消息内容和来源文档信息。

安装步骤

  1. 安装依赖: 确保已安装 Node.js 和 npm，然后运行以下命令安装项目依赖： 
    npm install
  2. 编译代码: 运行以下命令编译 TypeScript 代码到 JavaScript： 
    npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 Context Bank MCP 服务器。配置信息为 JSON 格式，示例如下：

{
  "serverName": "context-bank",
  "command": "npm",
  "args": ["start"]
}

配置参数说明:

  • 'serverName': 服务器名称，这里设置为 "context-bank"。
  • 'command': 启动服务器的命令，这里使用 'npm'。
  • 'args': 启动命令的参数，这里使用 'start'，对应 'package.json' 中定义的 'npm start' 脚本。

环境变量配置: Context Bank MCP 服务器依赖以下环境变量进行配置，您需要配置 '.env' 文件或在运行环境中设置这些变量。

必须配置的环境变量:

  • 'ONYX_API_KEY': 您的 AtherOS API 密钥。
  • 'ONYX_API_BASE': AtherOS API 的基础 URL (例如: '"http://172.30.22.52:3000"' )。

可选配置的环境变量:

  • 'PORT': 服务器监听的端口号，默认为 '3000'。
  • 'NODE_ENV': 运行环境模式，可选 'development', 'production', 'test'。
  • 'LOG_LEVEL': 日志级别，可选 'info', 'debug', 'error', 'warn'。

您可以使用 'npm run setup' 命令进行交互式配置，或者手动复制 '.env.example' 文件并修改内容。

基本使用方法

  1. 启动服务器: 编译完成后，可以通过以下命令启动 MCP 服务器：

    npm start

    或者直接运行编译后的 JavaScript 文件：

    ./build/index.js

    服务器启动后，将通过 stdio 协议等待 MCP 客户端的连接和请求。

  2. MCP 客户端交互: 使用兼容 MCP 协议的客户端（如 LLM 应用）连接到该 MCP 服务器。客户端可以通过 JSON-RPC 请求调用服务器提供的工具：

    • 'create-chat-session': 创建新的聊天会话。
    • 'query-atheros': 在指定聊天会话中发送消息进行知识库查询。

    具体工具的参数和使用方法请参考仓库 README.md 文件中 "API Tools" 部分的描述。服务器会将处理结果以 JSON-RPC 响应的形式返回给客户端。

信息

分类

网页与API

访问项目