Oxynote — Claude Code MCP server: what it does, how to install
Connects self-hosted docs and live metric panels to AI agents over MCP. Reads, searches, and drafts internal guides directly from your assistant.
Open on GitHubWhat Oxynote 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.
What it helps with
- 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 for the agent
- Find the incident response runbook for payment services in Oxynote
- Draft an API reference page for
GET /v1/shipments/{id}with response field details
How to install Oxynote
1Template address
The server address is a template: replace {…} or […] with your own values
2Platform CLI: remote server
claude mcp add --transport http oxynote https://{host}/core/api/mcp1Template address
The server address is a template: replace {…} or […] with your own values
2Platform CLI: remote server
codex mcp add oxynote --url https://{host}/core/api/mcp1Template address
The server address is a template: replace {…} or […] with your own values
2Config file
{
"mcpServers": {
"oxynote": {
"url": "https://{host}/core/api/mcp"
}
}
}1Template address
The server address is a template: replace {…} or […] with your own values
2Config file
{
"servers": {
"oxynote": {
"type": "http",
"url": "https://{host}/core/api/mcp"
}
}
}1Template address
The server address is a template: replace {…} or […] with your own values
2Platform CLI: remote server
gemini mcp add -t http oxynote https://{host}/core/api/mcpStep by step, with commands for each platform: How to add an MCP server to Claude Code, Codex, Cursor, VS Code, Gemini CLI and more
Questions about Oxynote
How to install Oxynote in Claude Code?
Run claude mcp add --transport http oxynote https://{host}/core/api/mcp in your terminal, replacing {host} with your server domain or IP.
What does the Oxynote MCP server do?
It connects your self-hosted Oxynote documentation workspace to AI coding assistants, letting them query, read, and draft pages containing live Prometheus metrics.
How do you start the self-hosted Oxynote container?
Start it with docker run -d --name oxynote -p 8080:8080 -v oxynote_data:/oxynote/data ghcr.io/oxynote/oxynote:latest. Access the web app at http://localhost:8080 using [email protected] and password oxynote-admin-1234.
