Onyx MCP Server logo

Onyx MCP Server

by lupuletic

Onyx 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.

View on GitHub

Last updated: N/A

What is Onyx MCP Server?

Onyx MCP Server is a Model Context Protocol (MCP) server that facilitates seamless integration between MCP clients and Onyx AI knowledge bases. It acts as a bridge, enabling users to search and retrieve relevant context from their documents within Onyx through any MCP-compatible application.

How to use Onyx MCP Server?

To use the Onyx MCP Server, you need to install it via Smithery or manually by cloning the repository, installing dependencies, building the server, and configuring your Onyx API token and URL. Then, configure your MCP client (e.g., Claude Desktop, Cline) to connect to the server by providing the command to run the server, the path to the built server file, and the necessary environment variables. Once configured, you can use the search_onyx and chat_with_onyx tools within your MCP client to interact with your Onyx knowledge base.

Key features of Onyx MCP Server

  • 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

Use cases of Onyx MCP Server

  • Knowledge Management: Access your organization's knowledge base through any MCP-compatible interface

  • Customer Support: Help support agents quickly find relevant information

  • Research: Conduct deep research across your organization's documents

  • Training: Provide access to training materials and documentation

  • Policy Compliance: Ensure teams have access to the latest policies and procedures

FAQ from Onyx MCP Server

What is the purpose of the Onyx MCP Server?

It connects MCP clients to Onyx knowledge bases, enabling search and retrieval of relevant context.

How do I install the Onyx MCP Server?

You can install it via Smithery or manually by cloning the repository and following the setup instructions.

What are the prerequisites for using the server?

You need Node.js, an Onyx instance with API access, and an Onyx API token.

How do I configure my MCP client to use the server?

You need to provide the command to run the server, the path to the built server file, and environment variables for ONYX_API_TOKEN and ONYX_API_URL.

What tools are available once the server is configured?

The search_onyx tool for direct search and the chat_with_onyx tool for comprehensive answers using Onyx's chat API.