# Oxynote

Connects self-hosted docs and live metric panels to AI agents over MCP. Reads, searches, and drafts internal guides directly from your assistant.

- MCP server · `type=mcp` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline, Zed, Gemini CLI · ★ 352
- Author: oxynote
- License: Apache-2.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/oxynote/oxynote
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/mcp/oxynote

## What it does

Oxynote pairs technical guides with interactive Prometheus queries on the same page. Internal APIs display in a two-column layout: response fields on the left, `curl` snippets and live p99 latency figures on the right. The whole workspace deploys as a single Docker container using `ghcr.io/oxynote/oxynote:latest`.

An HTTP endpoint at `/core/api/mcp` connects coding agents directly to the platform. Through MCP, an assistant can fetch runbooks, search articles, or submit documentation drafts for review. That saves engineers from digging through disconnected dashboards during an outage.

The MCP client will not function without a running Oxynote instance: replace `{host}` in the command with your actual server address.

## Requirements
- Needs: Docker
- Remote server: `https://{host}/core/api/mcp`

## Install

### Claude Code (native platform)

1. **Template address**
- The server address is a template: replace {…} or […] with your own values

2. **Platform CLI: remote server**
```bash
claude mcp add --transport http oxynote https://{host}/core/api/mcp
```

### Codex

1. **Template address**
- The server address is a template: replace {…} or […] with your own values

2. **Platform CLI: remote server**
```bash
codex mcp add oxynote --url https://{host}/core/api/mcp
```

### Cursor

1. **Template address**
- The server address is a template: replace {…} or […] with your own values

2. **Config file**
File `.cursor/mcp.json`:
```json
{
    "mcpServers": {
        "oxynote": {
            "url": "https://{host}/core/api/mcp"
        }
    }
}
```

### GitHub Copilot

1. **Template address**
- The server address is a template: replace {…} or […] with your own values

2. **Config file**
File `.vscode/mcp.json`:
```json
{
    "servers": {
        "oxynote": {
            "type": "http",
            "url": "https://{host}/core/api/mcp"
        }
    }
}
```

### Gemini CLI

1. **Template address**
- The server address is a template: replace {…} or […] with your own values

2. **Platform CLI: remote server**
```bash
gemini mcp add -t http oxynote https://{host}/core/api/mcp
```

## When to use it
- query internal service documentation and runbooks from an AI chat
- draft and review API references alongside telemetry panels
- inspect metric thresholds and system explanations together

## Example prompts
- Find the incident response runbook for payment services in Oxynote
- Draft an API reference page for `GET /v1/shipments/{id}` with response field details

## Similar
- [Reactive Resume](https://affpapa.org/en/nevibecode/mcp/reactive-resume.md) — MCP server · ★ 44874
- [Sui Knowledge Base (kapa.ai)](https://affpapa.org/en/nevibecode/mcp/sui-knowledge-base-kapaai.md) — MCP server · ★ 7784
- [Claude Code Ultimate Guide](https://affpapa.org/en/nevibecode/mcp/claude-code-ultimate-guide.md) — MCP server · ★ 6237
- [Zotero MCP](https://affpapa.org/en/nevibecode/mcp/zotero-mcp.md) — MCP server · ★ 5548
- [RevoGrid DataGrid MCP Pro](https://affpapa.org/en/nevibecode/mcp/revogrid-datagrid-mcp-pro.md) — MCP server · ★ 3450
- [Claude Code Explorer MCP](https://affpapa.org/en/nevibecode/mcp/codeaashu-claude-code-explorer-mcp.md) — MCP server · ★ 3409

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md