知识库查询接口

Context Bank MCP是一个基于模型上下文协议(MCP)的项目,通过API查询AtherOS知识库,支持创建聊天会话和发送查询。

  • by vulh1209
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 vulh1209/context-bank-mcp

使用说明

背景银行MCP

概述

上下文库MCP是一个使用模型上下文协议(MCP)创建接口的项目,用于通过API查询AtherOS知识库。该项目构建了一个能够与Onyx API交互的MCP服务器,以创建聊天会话并向知识库发送查询。

特性

  • 创建新的聊天会话以查询知识库
  • 向聊天会话发送消息以接收来自知识库的响应
  • 格式化和显示Onyx API的结果

使用的技术

  • TypeScript
  • Node.js
  • 模型上下文协议(MCP)SDK
  • Zod用于数据验证
  • Axios用于HTTP请求

安装

# Install dependencies
npm install

# Compile source code
npm run build

配置

该项目使用环境变量连接到Onyx API。按照以下步骤配置您的环境:

自动设置(推荐)

运行安装脚本以交互方式配置环境:

npm run setup

此脚本将:

  1. 创建一个 .env 如果文件不存在
  2. 提示您输入AtherOS API密钥
  3. 允许您自定义API基础URL
  4. 为其他配置选项设置默认值

手动设置

  1. 复制示例环境文件以创建您自己的:
cp .env.example .env
  1. 编辑 .env 使用您的特定配置文件:
# AtherOS API Configuration
ONYX_API_KEY=your_api_key_here
ONYX_API_BASE=http://your_api_base_url:port

# Server Configuration
PORT=3000
NODE_ENV=development

# Optional: Logging Configuration
LOG_LEVEL=info

环境变量

  1. 所需的环境变量:

    • ONYX_API_KEY:您的AtherOS API密钥
    • ONYX_API_BASE:AtherOS API的基本URL(例如,“http://172.30.22.52:3000")
  2. 可选环境变量:

    • PORT:服务器的端口号(默认值:3000)
    • NODE_ENV:环境模式(开发、生产、测试)
    • LOG_LEVEL:日志记录级别(信息、调试、错误、警告)

用法

编译后,您可以使用命令行工具:

# Direct usage
./build/index.js

# Or through npm
npm start

API工具

该项目提供了两个主要的MCP工具:

1.创建聊天会话

创建新的聊天会话以查询知识库。

参数:

  • persona_id (默认值:0):用户ID
  • description (默认:“”):聊天会话描述

2.查询_理论

向聊天会话发送消息以查询AtherOS知识库。

参数:

  • chat_session_id:聊天会话ID
  • message:消息内容
  • parent_message_id:父消息ID(可以为空)

响应格式

知识库查询的响应包括:

  • 消息ID
  • 消息内容
  • 重新表述的查询(如果可用)
  • 有关顶级源文件的信息(如果可用):
    • 文档名称
    • 相关度分数
    • 文档链接

建筑

该项目结构简单:

  • src/index.ts:应用程序的主要入口点,定义MCP工具和连接逻辑
  • 使用stdio协议与MCP服务器通信

发展

# Compile and view changes
npm run build

# Run in development mode
npm run dev

许可证

国际协调委员会