Onyx MCP Server
by bywaleedio.github.ByWaleed/onyx-mcpv0.2.1
Secure MCP access to Onyx search, chat, projects, and administration.
context tax
queued
security
queued
cold start
queued
freshness
Active19d ago
Install Onyx MCP server
Install in Claude Code
claude mcp add onyx -e ONYX_API_URL='<onyx-api-url>' -e ONYX_API_TOKEN='<onyx-api-token>' -- npx -y onyx-mcpInstall in Cursor
{
"mcpServers": {
"onyx": {
"command": "npx",
"args": [
"-y",
"onyx-mcp"
],
"env": {
"ONYX_API_URL": "<onyx-api-url>",
"ONYX_API_TOKEN": "<onyx-api-token>"
}
}
}
}Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project).
Install in Claude Desktop
{
"mcpServers": {
"onyx": {
"command": "npx",
"args": [
"-y",
"onyx-mcp"
],
"env": {
"ONYX_API_URL": "<onyx-api-url>",
"ONYX_API_TOKEN": "<onyx-api-token>"
}
}
}
}Settings → Developer → Edit Config (claude_desktop_config.json), then restart.
Install in VS Code
{
"servers": {
"onyx": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"onyx-mcp"
],
"env": {
"ONYX_API_URL": "<onyx-api-url>",
"ONYX_API_TOKEN": "<onyx-api-token>"
}
}
}
}Add to .vscode/mcp.json in your workspace.
Install in Windsurf
{
"mcpServers": {
"onyx": {
"command": "npx",
"args": [
"-y",
"onyx-mcp"
],
"env": {
"ONYX_API_URL": "<onyx-api-url>",
"ONYX_API_TOKEN": "<onyx-api-token>"
}
}
}
}Add to ~/.codeium/windsurf/mcp_config.json.
Configuration
| Variable | Required | Secret | Description |
|---|---|---|---|
| ONYX_API_URL | yes | — | Onyx API base URL, for example https://onyx.example.com/api |
| ONYX_API_TOKEN | yes | yes | Onyx Personal Access Token or API key |
| ONYX_DEFAULT_PERSONA_ID | — | — | Default Onyx agent ID for new chats |
| ONYX_MCP_ENABLE_WEB_FETCH | — | — | Enable web search and allowlisted URL fetching |
| ONYX_MCP_WEB_FETCH_ALLOWLIST | — | — | Comma-separated hostnames permitted for HTTPS URL fetching |
Freshness
Active — last maintenance signal 19d ago. The newest of the signals below sets the band.
Last commit (default branch)
2026-09-21 · 19d ago · GitHub
Latest release
2026-08-30 · 41d ago · GitHub · v0.2.1
Package published
no data · npm/PyPI
Registry entry updated
2026-08-30 · 41d ago · official registry · v0.2.1
FAQ
›How do I install the Onyx MCP server in Claude Code?
Run: claude mcp add onyx -e ONYX_API_URL='<onyx-api-url>' -e ONYX_API_TOKEN='<onyx-api-token>' -- npx -y onyx-mcp. For Cursor, VS Code, Claude Desktop and Windsurf, use the install tabs above.
›Does Onyx require an API key?
Yes. It expects ONYX_API_URL, ONYX_API_TOKEN, of which 1 is a secret.
›Can I use Onyx as a remote (hosted) MCP server?
No hosted endpoint is published; it runs locally over stdio.
›Is Onyx in the official MCP registry?
Yes, as io.github.ByWaleed/onyx-mcp.