refmdio/mcp-server

RefMD MCP Server

A Model Context Protocol server that exposes RefMD documents over a hosted SSE endpoint, so chatbots can browse and edit Markdown through RefMD's API.

Features

• Streamable HTTP/SSE transport compatible with hosted MCP clients (e.g. Claude, Cursor)
• Resource template refmd://document/{id} to read document Markdown and metadata
• Tools for listing, searching, creating, and updating documents via the RefMD API
• Chunked document reads through optional offset/limit parameters (each call returns up to 120,000 characters)
• Partial Markdown patching via refmd-patch-document-content (insert/delete/replace without reuploading the entire file)

Prerequisites

• Node.js 18+
• Access to an existing RefMD instance
• Either a personal access token (JWT) or credentials that can log in via /api/auth/login

Configuration

The server now authenticates users via OAuth 2.1 with PKCE. Configure it with the following variables:

Allowing multiple hosted clients: set OAUTH_CLIENT_IDS to a comma-separated list (e.g. chatgpt-connector,Claude) and mirror the same set in OAUTH_ALLOWED_REDIRECTS. Leaving either variable empty keeps it open to any HTTPS redirect, but as soon as you specify one value you must list every connector you want to permit.

Remote MCP clients (Claude Web included) expect the OAuth Protected Resource Metadata document at https://<host>/.well-known/oauth-protected-resource so they can follow the resource_metadata hint in WWW-Authenticate challenges. The server serves that document automatically (including mirrored aliases like /mcp/.well-known/...), so make sure your reverse proxy forwards those paths.

If you terminate TLS in a reverse proxy, make sure it forwards either the standard Forwarded header or X-Forwarded-Proto / X-Forwarded-Host so the OAuth metadata advertises the correct https:// origin. Set OAUTH_ISSUER=https://your-domain if you prefer an explicit override.

ℹ️ Install the appropriate database driver when enabling persistence:
npm install better-sqlite3 for SQLite, npm install pg for PostgreSQL, or npm install mysql2 for MySQL/MariaDB.

Install & Build

cd mcp-server
npm install
npm run build

Run

npm start
REFMD_API_BASE="https://refmd.example.com" \
OAUTH_CLIENT_IDS="chatgpt-connector" \
OAUTH_ALLOWED_REDIRECTS="https://chat.openai.com/aip/mcp/oauth/callback" \
npm start

The server exposes two transports:

• http://<host>:<port>/sse — SSE transport (compatible with Claude SSE etc.)
• http://<host>:<port>/mcp — Streamable HTTP transport (one-shot POST per exchange)

OAuth flow

1. Configure your client (e.g. ChatGPT custom connector) with:
   • Authorization URL: https://your-domain.example.com/oauth/authorize
   • Token URL: https://your-domain.example.com/oauth/token
   • Revocation URL: https://your-domain.example.com/oauth/revoke
   • Scopes: (leave blank)
   • PKCE: enabled (ChatGPT uses S256 automatically)
2. When prompted, the browser shows the RefMD MCP consent page. Paste a RefMD API token generated from Profile → API tokens and approve.
3. The connector receives an access token and can call /sse or /mcp with Authorization: Bearer <token>.

Tokens can be revoked from RefMD (profile page) or via POST /oauth/revoke.

Run with Docker

# Build image
docker build -t refmd-mcp .

docker run -p 3334:3334 \
  -e REFMD_API_BASE="https://refmd.example.com" \
  -e OAUTH_CLIENT_IDS="chatgpt-connector" \
  -e OAUTH_ALLOWED_REDIRECTS="https://chat.openai.com/aip/mcp/oauth/callback" \
  -e MCP_DB_DRIVER="sqlite" \
  -e MCP_DB_SQLITE_PATH="/data/refmd-mcp.sqlite" \
  -v refmd-mcp-data:/data \
  refmd-mcp

Mount a persistent volume (as shown above) so the SQLite database file survives container restarts.

Connecting a Chat Client

• Claude (CLI):

  claude mcp add --transport sse refmd https://your-domain.example.com/sse
  

• Cursor / VS Code / MCP Inspector: choose an SSE transport and supply the same URL.

Once connected, resources appear under refmd://document/{id}. Available tools include refmd-list-documents, refmd-search-documents, refmd-create-document, refmd-read-document, refmd-update-document-content, and more.

Reading Large Documents

The refmd-read-document tool and the refmd://document/{id} resource both support optional pagination parameters so large Markdown files stay under the Model Context Protocol payload limits:

• offset (default 0): starting character position (zero-based).
• limit (default 120000, capped at 120000): maximum characters to return in the response.

Example resource URI: refmd://document/123e4567-e89b-12d3-a456-426614174000?offset=60000&limit=60000.

Each response includes range metadata and the next offset so clients can issue follow-up calls until the full document is retrieved.

Patching Document Content

Use the refmd-patch-document-content tool to insert, delete, or replace specific spans without sending the entire Markdown body:

{
  "id": "document-uuid",
  "operations": [
    { "op": "insert", "offset": 120, "text": "New paragraph." },
    { "op": "delete", "offset": 42, "length": 5 }
  ]
}

Offsets/lengths are counted in Unicode code points to match RefMD’s editor behavior. The server validates ranges and applies the operations atomically before emitting document-change events, so downstream integrations stay in sync.

Release workflow

The GitHub Actions workflow CI MCP Server ships the container image. It runs automatically on pushes/PRs touching mcp-server and publishes to GHCR when:

• the push is a tag matching mcp-server-v* (versioned release), or
• the workflow is manually triggered with publish=true.

Tags published to ghcr.io/<owner>/refmd-mcp include semantic versions (1.2.0, 1.2, 1), the raw git tag, and latest. Use the extra-tag input for additional labels when invoking the workflow manually.

Development

Run in watch mode with TSX:

npm run dev

Any code changes require a rebuild (npm run build) before deploying or running with npm start.