Skip to content

README.adoc

Latest commit

 

History

History
138 lines (97 loc) · 4.49 KB

README.adoc

File metadata and controls

138 lines (97 loc) · 4.49 KB

MCP Server Documentation

Table of Contents

Documentation for the Redpanda Doc Tools MCP (Model Context Protocol) server.

The MCP server exposes doc-tools execution functionality to Claude Code, allowing technical writers to automate documentation generation tasks through natural conversation.

Note
 Team standards (style guide, content architecture, etc.) have been migrated to the docs-team-standards Claude Code plugin. This MCP server now focuses on execution tools only.

Documentation

For users (technical writers)

User guide

Complete guide to using the MCP server with Claude Code

  • Setup and installation

  • Available tools

  • Usage examples and workflows

  • Troubleshooting

Cost reference

Understanding and optimizing MCP tool costs

  • Cost breakdown by tool ($0.017 - $0.190 per operation)

  • Model selection guidance (Haiku/Sonnet/Opus)

  • Cost optimization strategies

For developers

Development guide

Guide for working on the MCP server

  • Architecture overview

  • Adding new tools programmatically

  • Testing guidelines

  • Security and best practices

CLI interface contract

Contract specification for the doc-tools CLI

  • Command structure and syntax

  • Output format contracts

  • Error handling requirements

  • Stability guarantees

CLI reference

Complete command reference for doc-tools

  • All commands and subcommands

  • Options and usage examples

  • Auto-generated from CLI help

Test documentation

How to run and write MCP tests

  • Test types (integration, contract, unit)

  • Running tests

  • Understanding failures

Quickstart

Install and configure

cd /path/to/docs-extensions-and-macros
npm install
npx doc-tools setup-mcp --local

Restart Claude Code

After setup, restart Claude Code to load the MCP server.

Start using it

Navigate to any Redpanda repository and start chatting:

You: "What's the latest Redpanda version?"
Claude: *uses get_redpanda_version tool*

You: "Generate property docs for v25.3.1"
Claude: *uses generate_property_docs tool*

What’s included

Documentation generation tools

  • Version information: Get latest Redpanda and Console versions

  • Property docs: Generate configuration property documentation

  • Metrics docs: Generate metrics reference documentation

  • RPK docs: Generate RPK CLI documentation

  • Connector docs: Generate Redpanda Connect connector documentation

  • Helm docs: Generate Helm chart documentation

  • CRD docs: Generate Kubernetes CRD documentation

  • OpenAPI bundling: Bundle OpenAPI fragments

  • Cloud regions: Generate cloud regions documentation

Utility tools

  • Antora structure: Analyze documentation repository structure

  • Review generated docs: Quality check generated documentation

  • Job management: Background job status and listing

Resources

The only resource provided by this MCP server is:

  • redpanda://personas: Target audience personas (loaded from current repo’s docs-data/personas.yaml)

All other resources (style guide, content architecture, etc.) have been migrated to the docs-team-standards Claude Code plugin.

Architecture

The MCP server consists of:

  • Server (bin/doc-tools-mcp.js): Main MCP protocol handler

  • Tool modules (bin/mcp-tools/): Individual tool implementations

  • Tests (tests/mcp/): Integration, contract, and unit tests

Migration notice

As of January 2025, the following have been migrated to the docs-team-standards Claude Code plugin:

  • Prompts: All MCP prompts are now Claude Code skills and agents

  • Resources: Style guide, content architecture, learning objectives, etc. are now Claude Code skills

The MCP server now focuses exclusively on execution tools that require CLI or web access.