Onyx MCP Server

基本能力

产品定位

Onyx MCP Server 是一个连接 MCP 兼容客户端与 Onyx 知识库的中间件，旨在提供高效的语义搜索和智能聊天功能。

核心功能

• 增强搜索：支持跨文档集的语义搜索，并带有 LLM 相关性过滤
• 上下文窗口检索：检索匹配块上下文的额外内容以提供更好的上下文理解
• 完整文档检索：可选择检索整个文档而不仅仅是内容块
• 聊天集成：使用 Onyx 强大的聊天 API，结合 LLM 和 RAG 技术提供全面答案
• 可配置文档集过滤：针对特定文档集进行更精准的结果筛选

适用场景

• 知识管理：通过 MCP 兼容接口访问组织知识库
• 客户支持：帮助支持人员快速找到相关信息
• 研究：在组织文档中进行深度研究
• 培训：提供培训材料和文档的访问
• 政策合规：确保团队能够访问最新政策和程序

工具列表

1. 搜索工具(search_onyx)：
2. 提供对 Onyx 搜索功能的直接访问，支持增强的上下文检索

3. 参数包括查询字符串、文档集筛选、最大结果数、上下块数等

4. 聊天工具(chat_with_onyx)：

5. 利用 Onyx 的聊天 API 提供综合答案
6. 支持会话上下文维护，可通过 chat_session_id 保持对话连续性

常见问题解答

• 如何选择搜索和聊天工具？
• 搜索工具适用于需要特定、针对性信息的情况
• 聊天工具适用于需要综合答案或信息合成的情况
• 最佳实践是结合使用两种工具

使用教程

使用依赖

• Node.js (v16 或更高版本)
• 具有 API 访问权限的 Onyx 实例
• Onyx API 令牌

安装教程

1. 通过 Smithery 自动安装:

npx -y @smithery/cli install @lupuletic/onyx-mcp-server --client claude

1. 手动安装步骤:

git clone https://github.com/lupuletic/onyx-mcp-server.git
cd onyx-mcp-server
npm install
npm run build
export ONYX_API_TOKEN="your-api-token-here"
export ONYX_API_URL="http://localhost:8080/api"
npm start

调试方式

1. 开发模式运行:

npm run dev

1. 运行测试套件:

npm test

1. 带覆盖率的测试:

npm run test:coverage

1. 代码检查:

npm run lint

1. 修复代码检查问题:

npm run lint:fix

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。