Onyx MCP Server logo

Onyx MCP Server

by MCP-Mirror / lupuletic

The Onyx MCP Server seamlessly integrates with Onyx AI knowledge bases, connecting any MCP-compatible client to your Onyx knowledge base. It allows you to search and retrieve relevant context from your documents, providing 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?

The Onyx MCP Server is a Model Context Protocol (MCP) server that acts as a bridge between MCP clients and the Onyx API, enabling powerful semantic search and chat capabilities for Onyx AI knowledge bases.

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 App, Cline) to connect to the server by providing the command to run the server, the path to the built server file, and the environment variables for the Onyx API token and URL.

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-compatible clients to your Onyx knowledge base, enabling semantic search and chat capabilities.

What are the prerequisites for installing the server?

You need Node.js (v16 or higher), 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 the Onyx API token and URL. Consult your MCP client's documentation for specific instructions.

What tools are available once the server is configured?

The search_onyx tool for direct access to Onyx's search capabilities and the chat_with_onyx tool for leveraging Onyx's chat API with LLM + RAG.

When should I use the search tool vs. the chat tool?

Use search for targeted information from documents and chat for comprehensive answers that combine information from multiple sources.