Onyx MCP

Name: Onyx MCP
Author: ByWaleed

by ByWaleedversion 0.2.1i★ 0iRuns on your computer

Registry nameio.github.ByWaleed/onyx-mcp

Install

Overview

Description from the maker (original English)

Secure MCP access to Onyx search, chat, projects, and administration.

PopNx MCP’s three pillars

These three are never merged into one score: opinions, measurements and popularity are different things.

User voiceiNo reviews yetReviews open together with accounts in a later step
Our basic checksi2 of 2 passedChecked from public information; code not scanned yet
UsageiVery new↓ 44/wk · ★ 0

What you can do with it

We have not written a plain-language summary for this one yet. Below are the facts we read from the registry.

Connection: Runs on your computer
Transport: stdio
Category: Chat & email
You need to fill in: ONYX_API_URL, ONYX_API_TOKEN

Install

Pick the AI app you use, then copy the settings.

Before you install

Basic checks: 2 of 2 passed
Runs on your computer with your user’s permissions (files, network, apps).
You fill in yourself: ONYX_API_URL, ONYX_API_TOKEN, ONYX_DEFAULT_PERSONA_ID, ONYX_MCP_ENABLE_WEB_FETCH, ONYX_MCP_WEB_FETCH_ALLOWLIST

Values marked secret are keys to your account. Never share them or paste them into a chat.

You need

npmNode.js installed (for the npx command)

Which app do you use?

ClaudeClaude CodeCursorVS CodeChatGPT

Pick your app above. We remember it, so next time the button says “Install in …”.

Open Claude Desktop → Settings → Developer → Edit Config, and paste this into claude_desktop_config.json

{
  "mcpServers": {
    "onyx": {
      "command": "npx",
      "args": [
        "-y",
        "onyx-mcp"
      ],
      "env": {
        "ONYX_API_URL": "your-value",
        "ONYX_API_TOKEN": "your-value",
        "ONYX_DEFAULT_PERSONA_ID": "your-value",
        "ONYX_MCP_ENABLE_WEB_FETCH": "your-value",
        "ONYX_MCP_WEB_FETCH_ALLOWLIST": "your-value"
      }
    }
  }
}

Run this in your terminal

claude mcp add onyx --env ONYX_API_URL=your-value --env ONYX_API_TOKEN=your-value --env ONYX_DEFAULT_PERSONA_ID=your-value --env ONYX_MCP_ENABLE_WEB_FETCH=your-value --env ONYX_MCP_WEB_FETCH_ALLOWLIST=your-value -- npx -y onyx-mcp

Fill in the empty values before running it.

Open in Cursor

Or copy the settings yourself

Paste into .cursor/mcp.json in your project, or ~/.cursor/mcp.json

{
  "mcpServers": {
    "onyx": {
      "command": "npx",
      "args": [
        "-y",
        "onyx-mcp"
      ],
      "env": {
        "ONYX_API_URL": "your-value",
        "ONYX_API_TOKEN": "your-value",
        "ONYX_DEFAULT_PERSONA_ID": "your-value",
        "ONYX_MCP_ENABLE_WEB_FETCH": "your-value",
        "ONYX_MCP_WEB_FETCH_ALLOWLIST": "your-value"
      }
    }
  }
}

Your browser asks to open the app, then the app shows the settings and asks you to confirm. Key values are left empty for you to fill in.

Open in VS Code

Or copy the settings yourself

Paste into .vscode/mcp.json in your project

{
  "servers": {
    "onyx": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "onyx-mcp"
      ],
      "env": {
        "ONYX_API_URL": "your-value",
        "ONYX_API_TOKEN": "your-value",
        "ONYX_DEFAULT_PERSONA_ID": "your-value",
        "ONYX_MCP_ENABLE_WEB_FETCH": "your-value",
        "ONYX_MCP_WEB_FETCH_ALLOWLIST": "your-value"
      }
    }
  }
}

Your browser asks to open the app, then the app shows the settings and asks you to confirm. Key values are left empty for you to fill in.

This one runs on your computer, and ChatGPT can only connect to servers on the internet. Pick another app.

Your choice stays on this device in a cookie; no account needed.

Values you fill in

ONYX_API_URL required env
Onyx API base URL, for example https://onyx.example.com/api
ONYX_API_TOKEN secret required env
Onyx Personal Access Token or API key
ONYX_DEFAULT_PERSONA_ID env
Default Onyx agent ID for new chats
ONYX_MCP_ENABLE_WEB_FETCH env
Enable web search and allowlisted URL fetching
ONYX_MCP_WEB_FETCH_ALLOWLIST env
Comma-separated hostnames permitted for HTTPS URL fetching

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

Claude Goose LM Studio Msty Studio Cherry Studio Cursor VS Code + GitHub Copilot Visual Studio Windsurf (Devin Desktop)Zed Kiro Cline Continue JetBrains AI Assistant Claude Code Codex CLI Gemini CLI OpenCode nodecode Warp LibreChat Raycast

All apps, with pros and cons →

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 11, 2026

✓ Pass
Maker matches the repo
The registry name was verified with the GitHub account ByWaleed, which owns the repo
✓ Pass
Still maintained
Code last changed 2 days ago
… Not checked yet
Has a licence
We have not read this repo from GitHub yet
– Not applicable
Endpoint responds
This one runs on your computer; there is no internet endpoint
– Not applicable
Sign-in with OAuth
Runs on your computer and uses local settings instead
… Not checked yet
No hidden instructions in tool descriptions
Runs on your computer; we can only read tool lists from internet endpoints

Compared with others in Chat & emaili

More stars than 0% of the other 1933 servers in this category
Published to the registry more recently than 26% of the other 1933 servers in this category
Basic checks equal to or better than 100% of the other 1933 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Onyx MCP safe?

It passed 2 of 2 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: ONYX_API_URL, ONYX_API_TOKEN

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 2 days ago, and the latest version (0.2.1) reached the registry 2 months ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js on your computer.

What can I use instead?

In the same category: Inbox Zero, Agent-Native Mail, Agent-Native Dispatch

Alternatives

Servers in the same category from other makers, sorted by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

Inbox Zero

Search Gmail and Outlook, save drafts, manage email rules, and view email stats.

by elie222Widely used★ 13KUpdated 41 days ago

Runs in the cloud

Install

Agent-Native Mail

Agent-Native Superhuman - email client with keyboard shortcuts and AI triage

by BuilderIOWidely used★ 7.7KUpdated 2 months ago

Runs in the cloud

Install

Agent-Native Dispatch

Central Slack/Telegram router with jobs, memory, approvals, and A2A delegation

by BuilderIOWidely used★ 7.7KUpdated 2 months ago

Runs in the cloud

Install

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

Onyx MCP

MCP Registry name: io.github.ByWaleed/onyx-mcp

A comprehensive, secure Model Context Protocol server for Onyx, formerly Danswer.

This project exposes Onyx search, chat, agents, projects, documents, connectors, ingestion, and deployment-specific APIs to MCP clients. It is an independent community project and is not an official Onyx package.

Why This Server

Uses the current /chat/send-chat-message contract.
Defaults to Onyx's built-in assistant, persona 0.
Supports scoped Personal Access Tokens and legacy API keys.
Starts read-only.
Separately gates writes, administration, destructive actions, and raw API access.
Applies request timeouts and response-size limits.
Never logs authorization headers or tokens.
Includes an advanced raw API tool for deployment-specific endpoints.

Install

npx -y onyx-mcp@0.2.1

The pinned command is recommended for reproducible execution. Use npx -y onyx-mcp@latest only if you intentionally want automatic upgrades.

Versioned tarballs are attached to GitHub Releases. The previous scoped package, @bywaleed/onyx-mcp, is deprecated in favor of onyx-mcp.

Configuration

Required:

Variable	Description
`ONYX_API_URL`	Onyx API base URL, for example `https://onyx.example.com/api`
`ONYX_API_TOKEN`	Onyx PAT or API key

Optional:

Variable	Default	Description
`ONYX_DEFAULT_PERSONA_ID`	`0`	Default agent used for new chats
`ONYX_MCP_ENABLE_WRITE`	`false`	Registers tools that create or modify data
`ONYX_MCP_ENABLE_ADMIN`	`false`	Registers administrative tools
`ONYX_MCP_ENABLE_DESTRUCTIVE`	`false`	Registers destructive tools; write must also be enabled
`ONYX_MCP_ENABLE_RAW_API`	`false`	Registers the advanced raw API tool; admin access is also required
`ONYX_MCP_ENABLE_WEB_FETCH`	`false`	Registers web search and URL-fetching tools
`ONYX_MCP_WEB_FETCH_ALLOWLIST`	empty	Comma-separated hostnames allowed for HTTPS URL fetching
`ONYX_MCP_TIMEOUT_MS`	`30000`	Request timeout
`ONYX_MCP_MAX_RESPONSE_BYTES`	`1000000`	Maximum accepted response body
`ONYX_MCP_MAX_CONCURRENCY`	`8`	Maximum concurrent requests to Onyx
`ONYX_MCP_MAX_QUEUE`	`100`	Maximum requests waiting for a concurrency slot

Onyx still enforces the permissions attached to the supplied token. Enabling a profile cannot grant additional Onyx privileges.

OpenCode

"mcp": { "onyx": { "type": "local", "command": ["npx", "-y", "onyx-mcp@0.2.1"], "environment": { "ONYX_API_URL": "https://onyx.example.com/api", "ONYX_API_TOKEN": "{env:ONYX_API_TOKEN}" }, "enabled": true } } }

Claude Desktop

"mcpServers": { "onyx": { "command": "npx", "args": ["-y", "onyx-mcp@0.2.1"], "env": { "ONYX_API_URL": "https://onyx.example.com/api", "ONYX_API_TOKEN": "your-token" } } } }

Tool Profiles

The read-only profile includes health, identity, permissions, search, chat history, agents, projects, files, tools, document sets, and connector status.

The write profile adds chat creation, chat messages, feedback, and project updates.

The admin profile adds connector, credential, user, agent, and direct-ingestion administration.

The destructive profile adds individually confirmed deletion tools. Bulk deletion is intentionally not exposed as a first-class tool.

The raw API profile adds onyx_api_request. It covers APIs specific to an Onyx edition or version. Every raw request requires the admin profile. Every non-GET request also requires write and destructive access plus confirmation because arbitrary endpoint semantics cannot be inferred safely.

Tools

The default profile provides health, version, identity, permission, indexed search, agent, chat-history, project, file, document-set, tool, source, and connector-status tools. Write mode adds chat, feedback, and project mutations. Admin mode adds connector, credential, user, agent, and ingestion tools. Web search and URL fetching require a separate web-fetch opt-in. URL fetching accepts only HTTPS destinations matching the configured hostname allowlist; Onyx must also validate redirects and resolved addresses to prevent DNS rebinding.

Run onyx_capabilities to inspect the active profile. MCP clients can also call tools/list for complete machine-readable schemas and safety annotations.

Authentication

Prefer an Onyx PAT with the smallest required scope:

read:search for search.
read:chat for chat history.
write:chat for chat creation and messages.

Some Onyx endpoints still use legacy role checks and need an unrestricted PAT or API key. Use a separate administrative server configuration for those operations.

Treat client configuration files as sensitive when they contain a token. Use a dedicated least-privilege token and restrict file permissions to your user account.

Development

npm ci

npm run verify

Compatibility

Component	Supported
Node.js	20 and 22
MCP SDK/protocol	TypeScript SDK 1.x, MCP through `2025-11-25`
Onyx	Current community and enterprise APIs; tested against the repository version documented in releases
Transport	Local stdio

The server uses non-streaming Onyx chat responses for a stable MCP result. Onyx editions and releases expose different administrative routes. The raw API tool provides an escape hatch while first-class tools remain curated and safe. MCP SDK 2.x migration is planned as a separate breaking compatibility release.

Support And Security

Usage questions: GitHub Discussions
Bugs and feature requests: GitHub Issues
Vulnerabilities: private security advisory
Release history: CHANGELOG.md
Maintainer release process: RELEASING.md
MCP Registry metadata: server.json

License

MIT

Onyx MCP

Overview

PopNx MCP’s three pillars

What you can do with it

Install

Before you install

Values you fill in

Which apps can use it

What it can do

Basic checksi

Maker matches the repo

Still maintained

Has a licence

Endpoint responds

Sign-in with OAuth

No hidden instructions in tool descriptions

Compared with others in Chat & emaili

Common questions

Alternatives

Inbox Zero

Agent-Native Mail

Agent-Native Dispatch

README from the maker

Onyx MCP

Why This Server

Install

Configuration

OpenCode

Claude Desktop

Tool Profiles

Tools

Authentication

Development

Compatibility

Support And Security

License