# README.md Conventions for MCP Servers

Structure and content guide for creating or updating a README for an MCP server built on `@cyanheads/mcp-ts-core`. If a README already exists, use this as a reference to audit and improve it — don't blindly rewrite sections that are already accurate.

## Structure

Use this section order. Omit sections that don't apply (e.g., skip Docker/Workers if the server doesn't deploy there).

```text
# {Server Name}                         ← centered HTML block (h1 + tagline + surface count)
Info badges                             ← one centered row — Version, License, Docker, MCP SDK, npm, TypeScript, Bun
Install badges                          ← one centered row — Claude Desktop, Cursor, VS Code
Framework badge                         ← solo spotlight row — `Built on @cyanheads/mcp-ts-core` (cyan-300 #67E8F9)
[Public hosted callout if present]      ← centered HTML block, directly under the Framework badge
---
## Tools                                ← grouping sentence → summary table → per-tool subsections
## Resources and prompts (if any)       ← single combined table (Type / Name / Description)
## Features                             ← framework bullets + domain-specific bullets
## Getting started                      ← hosted (if any), bunx/npx/docker configs, HTTP one-liner, prerequisites, install
## Configuration                        ← env var table + `.env.example` pointer
## Running the server                   ← dev, production, Workers/Docker
## Project structure                    ← directory/purpose table
## Development guide                    ← link to CLAUDE.md/AGENTS.md, key rules
## License                              ← one line
```

## Section Guide

### Title Block

Centered HTML. The `<h1>` is the server name — use the scoped package name if published under a scope (e.g., `@cyanheads/my-mcp-server`). The `<p>` is a bold **action-first** one-liner: lead with what the server _does_, not what it _is_. List the headline actions/workflows, then end with `via MCP. STDIO or Streamable HTTP.` (or whichever transports apply). Avoid `MCP server for/that …` framings — they describe the wrapper instead of the capability. **Nest the surface count as a `<div>` inside the same `<p>`**, separated by `•` (U+2022 bullet) — not as a second `<p>`. This matches the shipping convention across `@cyanheads/*` servers.

```html
<div align="center">
  <h1>@cyanheads/my-mcp-server</h1>
  <p><b>Search projects, manage tasks, track teams via MCP. STDIO or Streamable HTTP.</b>
  <div>7 Tools • 2 Resources • 1 Prompt</div>
  </p>
</div>

<div align="center">

[![Version](https://img.shields.io/badge/Version-1.0.0-blue.svg?style=flat-square)](./CHANGELOG.md) [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg?style=flat-square)](./LICENSE) [![Docker](https://img.shields.io/badge/Docker-ghcr.io-2496ED?style=flat-square&logo=docker&logoColor=white)](https://github.com/users/cyanheads/packages/container/package/my-mcp-server) [![MCP SDK](https://img.shields.io/badge/MCP%20SDK-^1.29.0-green.svg?style=flat-square)](https://modelcontextprotocol.io/) [![npm](https://img.shields.io/npm/v/@cyanheads/my-mcp-server?style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/package/@cyanheads/my-mcp-server) [![TypeScript](https://img.shields.io/badge/TypeScript-^6.0.3-3178C6.svg?style=flat-square)](https://www.typescriptlang.org/) [![Bun](https://img.shields.io/badge/Bun-v1.3.2-blueviolet.svg?style=flat-square)](https://bun.sh/)

</div>

<div align="center">

[![Install in Claude Desktop](https://img.shields.io/badge/Install_in-Claude_Desktop-D97757?style=for-the-badge&logo=anthropic&logoColor=white)](https://github.com/cyanheads/my-mcp-server/releases/latest/download/my-mcp-server.mcpb) [![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=my-mcp-server&config=<BASE64_CONFIG>) [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode:mcp/install?<URLENCODED_JSON>)

[![Framework](https://img.shields.io/badge/Built%20on-@cyanheads/mcp--ts--core-67E8F9?style=flat-square)](https://www.npmjs.com/package/@cyanheads/mcp-ts-core)

</div>
```

Generate the `<BASE64_CONFIG>` (Cursor) and `<URLENCODED_JSON>` (VS Code) payloads — replace `<PACKAGE_NAME>` / `<SHORT_NAME>` and add `env` only for required API keys:

```bash
# Cursor: base64-encoded JSON. Split command/args, add env when keys are needed.
echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"],"env":{"API_KEY":"your-api-key"}}' | base64
# Without env (no required keys):
echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"]}' | base64

# VS Code: URL-encoded JSON. Same shape plus a `name` field.
node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"],env:{API_KEY:"your-api-key"}}))'
# Without env:
node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"]}))'
```

Both clients use the same `{command, args, env}` shape; VS Code adds a top-level `name`. Omit `env` entirely when no API keys are needed — don't include empty objects or framework-only vars like `MCP_TRANSPORT_TYPE`. Install links route through HTTPS endpoints (`cursor.com/en/install-mcp`, `vscode.dev/redirect`) because GitHub-rendered markdown strips non-HTTP schemes — a raw `cursor://` or `vscode:` link won't click through. Omit any install badge whose target doesn't apply (e.g. no `.mcpb` bundle → drop the Claude Desktop badge).

The header tagline must match the `package.json` `description`.

**Badge selection:** All info badges use `style=flat-square`; install badges use `style=for-the-badge`. Include what applies — don't add badges for things the server doesn't have:

| Badge | Row | When to include |
|:------|:----|:----------------|
| Version | info | Always — link to `CHANGELOG.md` |
| License | info | Always |
| Docker | info | Published to ghcr.io or Docker Hub |
| MCP SDK | info | Always — show the `@modelcontextprotocol/sdk` version |
| npm | info | Published to npm |
| TypeScript | info | Always |
| Bun | info | If using Bun (standard for this framework) |
| MCP Spec | info | Optional — rarely included; the SDK badge usually suffices |
| Status | info | Optional — Stable, Beta, etc. |
| Code Coverage | info | If coverage is tracked |
| Install in Claude Desktop | install | Repo publishes an `.mcpb` bundle on GitHub Releases (orange `D97757`, anthropic logo) |
| Install in Cursor | install | Published to npm — uses the official `cursor://` deep link |
| Install in VS Code | install | Published to npm — uses the official `vscode:mcp/install` deep link |
| Framework | spotlight | Always — links to `@cyanheads/mcp-ts-core` on npm. Cyan-300 (`67E8F9`) for dark text. **Solo on its own row.** |

**Layout:** three centered `<div>` blocks in a fixed order. (1) **Info row** — one line with all info badges in the order above (release/license/distribution first, then SDK/ecosystem/language). (2) **Install + spotlight block** — install badges on one line, then a blank line, then the Framework badge alone on its own line as the brand link back to the framework. (3) **Public hosted callout** if applicable (see next section). Add a `---` horizontal rule after the whole header block.

Omit a whole row when nothing in it applies — e.g. a server with no `.mcpb` bundle and not on npm has no install row at all, so the install + spotlight block collapses to just the Framework badge.

### Public Hosted Callout (if present)

If a public hosted instance is available, **promote it to a top-level callout** in its own centered `<div>` immediately below the Framework badge — don't bury it inside Getting Started. This is the highest-value piece of information for a visitor who wants to try the server with zero install.

```html
<div align="center">

**Public Hosted Server:** [https://my-server.example.com/mcp](https://my-server.example.com/mcp)

</div>
```

Keep the full connection-config JSON block inside a `### Public Hosted Instance` subsection under Getting Started (covered below). This callout is just the visibility pointer.

### Tools

This is the most important section — it tells humans and LLMs exactly what the server exposes. Three layers: a **grouping framing sentence**, a summary table, then per-tool subsections for tools with non-trivial behavior.

**Grouping framing sentence:** Lead with one sentence that explains how the tool surface is organized. Richer than a bare count — tells the reader what mental model to apply. Examples:

- "Seventeen tools grouped by shape — workflow helpers orchestrate common flows end-to-end, primitive tools expose fine-grained CRUD, and the instruction tool returns procedural guidance merged with live account state."
- "Nine tools for working with PubMed and NCBI data:"
- "Five tools covering project lifecycle — discovery, task CRUD, and team analytics."

If the tools aren't meaningfully grouped, a single sentence count ("Seven tools for working with Acme data:") is acceptable.

**Summary table:**

```markdown
## Tools

Seven tools for working with Acme data:

| Tool Name | Description |
|:----------|:------------|
| `acme_search_projects` | Search projects by name, status, or team. |
| `acme_create_task` | Create a new task in a project. |
| `acme_get_task` | Fetch one or more tasks by ID, with full or summary data. |
```

**Per-tool subsections:**

Below the table, add a `### tool_name` subsection for each tool that has meaningful detail beyond its one-line description. Include:

- Bullet list of key capabilities (what inputs it accepts, what filtering/pagination it supports, edge cases it handles)
- Link to example file if one exists: `[View detailed examples](./examples/tool_name.md)`
- Separate subsections with `---` horizontal rules

```markdown
### `acme_search_projects`

Search for projects using free-text queries and filters.

- Full-text search plus typed status/phase filters
- Geographic proximity filtering by coordinates and distance
- Pagination (up to 100 per page) and sorting
- Field selection to limit response size

[View detailed examples](./examples/acme_search_projects.md)

---

### `acme_get_task`

Fetch one or more tasks by ID, with full data or concise summaries.

- Batch fetch up to 5 tasks at once
- Full data includes subtasks, comments, attachments, and history
- Partial success reporting when some tasks in a batch fail
```

Skip the per-tool subsection for simple tools where the table description says everything (e.g., an `acme_get_field_values` lookup tool).

### Resources and Prompts (combined)

**Use a single combined table with a `Type` column** rather than separate `## Resources` and `## Prompts` sections. This is the shipping convention — it scales better when a server has only 1 or 2 of each, and co-locates related content.

```markdown
## Resources and prompts

| Type | Name | Description |
|:---|:---|:---|
| Resource | `acme://projects/{projectId}` | Project details by ID |
| Resource | `acme://tasks/{taskId}` | Task details by ID |
| Prompt | `project_summary` | Summarize a project's status and open tasks |
```

Use singular ("Resource and prompt") if there's only one of each.

**Always include the tool-coverage note** directly under the table. Many MCP clients are tool-only and don't surface resources — this tells both the reader and downstream agents that the data is still reachable:

```markdown
All resource data is also reachable via tools. Large collections (`projects`, `tasks`) are not exposed as resources — use the `list` operation on the corresponding tool instead.
```

If a prompt has an associated design doc or reference, link it in the same paragraph: `Design reference for the prompt: [\`docs/email-design-playbook.md\`](./docs/email-design-playbook.md).`

Derive all tool/resource/prompt rows directly from the actual definitions. Use the real names and descriptions from the Zod schemas.

### Features

Three subsection groups: framework capabilities, domain-specific capabilities, then agent-friendly output design. Bullet lists, not prose.

```markdown
## Features

Built on [`@cyanheads/mcp-ts-core`](https://www.npmjs.com/package/@cyanheads/mcp-ts-core):

- Declarative tool, resource, and prompt definitions — single file per primitive, framework handles registration and validation
- Unified error handling — handlers throw, framework catches, classifies, and formats
- Pluggable auth: `none`, `jwt`, `oauth`
- Swappable storage backends: `in-memory`, `filesystem`, `Supabase`, `Cloudflare KV/R2/D1`
- Structured logging with optional OpenTelemetry tracing
- STDIO and Streamable HTTP transports

Acme-specific:

- Type-safe client for the Acme v2 API
- Automatic cleaning and simplification of API responses for agent consumption
- Workflow tools parallelize related sub-requests under a configurable concurrency limit

Agent-friendly output:

- Provenance on every response — source labels, effective-query echo, and confidence/coverage caveats so agents can reason about trust
- Graceful partial failure — batch tools return per-item success/error rows instead of failing the request, with structured status codes and actionable next-step text
- Discriminated output contracts — typed status and source fields let callers branch on data, not string parsing
```

The **Agent-friendly output** subsection documents output-design choices that make the server work well as an AI-agent backend. Include it when the server exhibits at least two of these patterns. Write bullets grounded in the server's actual behavior — not aspirational framework capabilities. Examples of what fits:

- Provenance: source labels (`viaSource`, `source`), license/access-level fields, effective-query echo, best-effort warnings on lossy tiers
- Partial failure: per-item status in batch operations, structured error rows alongside successes, recovery hints ("Next Step" text)
- Discriminated outputs: union types on `source` or `status` fields, typed `unavailable` reasons, per-tier outcome traces (`triedTiers`)
- Response shaping: stripping upstream noise, normalizing inconsistent schemas, deduplicating nested structures

### Getting Started

Lead with the lowest-friction option. If a public hosted instance exists, show that first. Then the **three standard install configs in order — `bunx`, `npx`, `docker run`** — followed by the HTTP one-liner quickstart, then prerequisites and install steps.

**Standard three-block pattern** (the house style across shipping `@cyanheads/*` servers):

```markdown
## Getting started

Add the following to your MCP client configuration file. See [`docs/api-key.md`](./docs/api-key.md) for how to generate an API key.

\`\`\`json
{
  "mcpServers": {
    "my-server": {
      "type": "stdio",
      "command": "bunx",
      "args": ["@cyanheads/my-mcp-server@latest"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "ACME_API_KEY": "your-api-key"
      }
    }
  }
}
\`\`\`

Or with npx (no Bun required):

\`\`\`json
{
  "mcpServers": {
    "my-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@cyanheads/my-mcp-server@latest"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "ACME_API_KEY": "your-api-key"
      }
    }
  }
}
\`\`\`

Or with Docker:

\`\`\`json
{
  "mcpServers": {
    "my-server": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "MCP_TRANSPORT_TYPE=stdio",
        "-e", "ACME_API_KEY=your-api-key",
        "ghcr.io/cyanheads/my-mcp-server:latest"
      ]
    }
  }
}
\`\`\`

For Streamable HTTP, set the transport and start the server:

\`\`\`sh
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 ACME_API_KEY=... bun run start:http
# Server listens at http://localhost:3010/mcp
\`\`\`
```

Refer to "your MCP client configuration file" generically — don't prescribe `claude_desktop_config.json` by name. Different clients use different config paths and the server isn't client-specific.

**If a public hosted instance exists**, precede the three-block pattern with a `### Public Hosted Instance` subsection and wrap the local configs in a `### Self-Hosted / Local` subsection:

```markdown
### Public Hosted Instance

A public instance is available at `https://my-server.example.com/mcp` — no installation required. Point any MCP client at it via Streamable HTTP:

\`\`\`json
{
  "mcpServers": {
    "my-server": {
      "type": "streamable-http",
      "url": "https://my-server.example.com/mcp"
    }
  }
}
\`\`\`

### Self-Hosted / Local

[bunx / npx / docker blocks here]
```

**Prerequisites:** Include a Bun version line and any domain-specific setup (API key format, rate-limit tiers, required accounts). Don't just list Bun — readers need to know what else to prepare.

```markdown
### Prerequisites

- [Bun v1.3.2](https://bun.sh/) or higher (or Node.js v22+).
- An Acme API key — see [`docs/api-key.md`](./docs/api-key.md) for how to generate one.
```

**Installation:** Standard four steps (clone, cd, install, configure env):

```markdown
### Installation

1. **Clone the repository:**

\`\`\`sh
git clone https://github.com/cyanheads/my-mcp-server.git
\`\`\`

2. **Navigate into the directory:**

\`\`\`sh
cd my-mcp-server
\`\`\`

3. **Install dependencies:**

\`\`\`sh
bun install
\`\`\`

4. **Configure environment:**

\`\`\`sh
cp .env.example .env
# edit .env and set required vars
\`\`\`
```

Omit the clone/install steps if the server is npm-only (not meant to be cloned).

### Configuration

Table of environment variables. Include framework vars only if the server uses non-default values. Mark required vars with bold **Required.** in the description rather than a separate column. **Close with a pointer to `.env.example`** for the full list of optional overrides.

```markdown
## Configuration

| Variable | Description | Default |
|:---------|:------------|:--------|
| `ACME_API_KEY` | **Required.** API key for the Acme service. | — |
| `ACME_BASE_URL` | API base URL. | `https://api.acme.com` |
| `ACME_TIMEOUT_MS` | Per-request timeout in milliseconds. | `60000` |
| `MCP_TRANSPORT_TYPE` | Transport: `stdio` or `http`. | `stdio` |
| `MCP_HTTP_PORT` | Port for HTTP server. | `3010` |
| `MCP_AUTH_MODE` | Auth mode: `none`, `jwt`, or `oauth`. | `none` |
| `MCP_LOG_LEVEL` | Log level (RFC 5424). | `info` |
| `LOGS_DIR` | Directory for log files (Node.js only). | `<project-root>/logs` |
| `STORAGE_PROVIDER_TYPE` | Storage backend. | `in-memory` |
| `OTEL_ENABLED` | Enable [OpenTelemetry instrumentation](https://github.com/cyanheads/mcp-ts-core/tree/main/docs/telemetry) (spans, metrics, completion logs). | `false` |

See [`.env.example`](./.env.example) for the full list of optional overrides.
```

Source from the server config Zod schema and `.env.example`.

### Running the Server

Separate from Getting Started. Show dev, build + run, and Workers/Docker deployment if applicable.

```markdown
## Running the server

### Local development

- **Build and run:**

  \`\`\`sh
  # One-time build
  bun run rebuild

  # Run the built server
  bun run start:stdio
  # or
  bun run start:http
  \`\`\`

- **Run checks and tests:**

  \`\`\`sh
  bun run devcheck   # Lint, format, typecheck, security
  bun run test       # Vitest test suite
  bun run lint:mcp   # Validate MCP definitions against spec
  \`\`\`

### Docker

\`\`\`sh
docker build -t my-mcp-server .
docker run --rm -e ACME_API_KEY=your-key -p 3010:3010 my-mcp-server
\`\`\`

The Dockerfile defaults to HTTP transport, stateless session mode, and logs to `/var/log/my-mcp-server`. OpenTelemetry peer dependencies are installed by default — build with `--build-arg OTEL_ENABLED=false` to omit them.

### Cloudflare Workers

1. **Build the Worker bundle:**

\`\`\`sh
bun run build:worker
\`\`\`

2. **Deploy:**

\`\`\`sh
bun run deploy:prod
\`\`\`
```

Include the Docker or Workers subsection only if the server supports it. The Docker trailing paragraph (log directory, OTEL build arg) is important — it documents Dockerfile behavior that isn't obvious from the build command.

### Project Structure

Directory/purpose table orienting contributors to the codebase.

```markdown
## Project structure

| Directory | Purpose |
|:----------|:--------|
| `src/index.ts` | `createApp()` entry point — registers tools/resources/prompts and inits services. |
| `src/config` | Server-specific environment variable parsing and validation with Zod. |
| `src/mcp-server/tools` | Tool definitions (`*.tool.ts`). |
| `src/mcp-server/resources` | Resource definitions (`*.resource.ts`). |
| `src/mcp-server/prompts` | Prompt definitions (`*.prompt.ts`). |
| `src/services` | Domain service integrations. |
| `tests/` | Unit and integration tests mirroring `src/`. |
```

### Development Guide

Brief — link to CLAUDE.md/AGENTS.md for full details. State 3-4 key rules. **Include the "validate → normalize → never fabricate" bullet** — it's the canonical anti-hallucination convention for external API wrappers and reinforces the framework's `no fabricated signal` principle.

```markdown
## Development guide

See [`CLAUDE.md`/`AGENTS.md`](./CLAUDE.md) for development guidelines and architectural rules. The short version:

- Handlers throw, framework catches — no `try/catch` in tool logic
- Use `ctx.log` for request-scoped logging, `ctx.state` for tenant-scoped storage
- Register new tools and resources via the barrels in `src/mcp-server/*/definitions/index.ts`
- Wrap external API calls: validate raw → normalize to domain type → return output schema; never fabricate missing fields
```

### License

One line referencing the LICENSE file.

```markdown
## License

Apache-2.0 — see [LICENSE](LICENSE) for details.
```

## Principles

- **Accuracy over aspiration.** Only document what exists. Don't describe planned features as if they're implemented.
- **Tools first.** The tool surface is the most important content. Lead with it.
- **Tables over prose** for structured data (tools, config, directories). Scannable and diff-friendly.
- **Two-layer tool docs.** Grouping sentence + summary table for quick scanning, per-tool subsections for detail. Skip subsections for trivial tools.
- **Combined resources + prompts.** Single table with a `Type` column, not separate sections.
- **Promote hosted instances.** If there's a public URL, put it in a top-level callout under the badges — not buried in Getting Started.
- **Three install configs.** `bunx`, `npx`, `docker run` in that order. Each as a complete MCP-client JSON block.
- **Real names from code.** Tool names, env vars, and URIs must match the source exactly. Copy from the definitions, don't paraphrase.
- **Lowest friction first.** Hosted instance > bunx > npx > docker > clone.
- **No badges unless publishing.** Badges for unpublished packages are noise.
- **Client-agnostic framing.** Say "your MCP client configuration file", not `claude_desktop_config.json`.
- **Keep it current.** Update the README whenever tools are added or removed.
