LO

lupuletic/onyx-mcp-server

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

27 stars 12 forks 质量 71 趋势 11MIT

一款模型上下文协议(MCP)服务器,实现与Onyx AI知识库的无缝集成。

概览

一款模型上下文协议(MCP)服务器,实现与Onyx AI知识库的无缝集成。 该 MCP 服务器将任何兼容 MCP 的客户端连接到您的 Onyx 知识库,允许您从文档中搜索和检索相关上下文。它为 MCP 客户端与 Onyx API 之间提供了桥梁,实现强大的语义搜索和聊天功能。 - : 通过LLM相关性过滤在Onyx文档集间进行语义搜索 - : 检索匹配区块上下的区块以获得更好的上下文 - : 可检索整份文档而非仅是区块 - : 使用Onyx强大的聊天API配合LLM + RAG获得全面答案 - : 针对特定文档集以获得更相关的结果 通过Smithery自动安装Claude Desktop的Onyx MCP Server: - Node.js(v16或更高版本)- 带有API访问权限的Onyx实例- Onyx API令牌 添加到 ~/Library/Application Support/Claude/claude_desktop_config。

概述(AI 翻译)

一个模型上下文协议(MCP)服务器,实现与 Onyx AI 知识库的无缝集成。

该 MCP 服务器将任何兼容 MCP 的客户端连接到您的 Onyx 知识库,允许您从文档中搜索和检索相关上下文。它为 MCP 客户端与 Onyx API 之间提供了桥梁,实现强大的语义搜索和聊天功能。

特色

  • 增强型搜索:通过LLM相关性过滤,跨Onyx文档集进行语义搜索
  • 上下文窗口检索:检索匹配区块上下的区块以获得更好的上下文
  • 完整文档检索:可检索整份文档而非仅为块的选项
  • 聊天集成:使用Onyx强大的聊天API,支持LLM+RAG,获得全面答案
  • 可配置文档集过滤:针对特定文档集以获得更相关的结果

安装

通过Smithery安装

通过Smithery自动安装Claude Desktop的Onyx MCP Server:

先决条件

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

布置

  1. 克隆仓库:

  2. 安装依赖:

  3. 搭建服务器:

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

Onyx MCP Server

A Model Context Protocol (MCP) server for seamless integration with Onyx AI knowledge bases.

This MCP server connects any MCP-compatible client to your Onyx knowledge base, allowing you to search and retrieve relevant context from your documents. It provides a bridge between MCP clients and the Onyx API, enabling powerful semantic search and chat capabilities.

Features

  • Enhanced Search: Semantic search across your Onyx document sets with LLM relevance filtering
  • Context Window Retrieval: Retrieve chunks above and below the matching chunk for better context
  • Full Document Retrieval: Option to retrieve entire documents instead of just chunks
  • Chat Integration: Use Onyx’s powerful chat API with LLM + RAG for comprehensive answers
  • Configurable Document Set Filtering: Target specific document sets for more relevant results

Installation

Installing via Smithery

To install Onyx MCP Server for Claude Desktop automatically via Smithery:

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

Prerequisites

  • Node.js (v16 or higher)
  • An Onyx instance with API access
  • An Onyx API token

Setup

  1. Clone the repository:

    git clone https://github.com/lupuletic/onyx-mcp-server.git
    cd onyx-mcp-server
    
  2. Install dependencies:

    npm install
    
  3. Build the server:

    npm run build
    
  4. Configure your Onyx API Token:

    export ONYX_API_TOKEN="your-api-token-here"
    export ONYX_API_URL="http://localhost:8080/api"  # Adjust as needed
    
  5. Start the server:

    npm start
    

Configuring MCP Clients

For Claude Desktop App

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "onyx-search": {
      "command": "node",
      "args": ["/path/to/onyx-mcp-server/build/index.js"],
      "env": {
        "ONYX_API_TOKEN": "your-api-token-here",
        "ONYX_API_URL": "http://localhost:8080/api"
      },
在 GitHub 查看完整 README

安装

npx -y @smithery/cli install @lupuletic/onyx-mcp-server --client claude
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "onyx-search": { "command": "node", "args": ["/path/to/onyx-mcp-server/build/index.js"], "env": { "ONYX_API_TOKEN": "your-api-token-here", "ONYX_API_URL": "http://localhost:8080/api" }, "disabled": false, "alwaysAllow": [] } } }