polish-docs-meta

Audit and polish MCP server documentation and metadata for ship readiness.

148|28|Updated Mar 20, 2025
One-click install
npx skills add https://github.com/cyanheads/mcp-ts-core --skill polish-docs-meta
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: polish-docs-meta
Source: https://github.com/cyanheads/mcp-ts-core/tree/main/skills/polish-docs-meta
Command: npx skills add https://github.com/cyanheads/mcp-ts-core --skill polish-docs-meta

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Finalize documentation and project metadata for a ship-ready MCP server. Use after implementation is complete, tests pass, and devcheck is clean. Safe to run at any stage — each step checks current state and only acts on what still needs work.

Core Features & Use Cases

  • Audit the surface area by scanning all tools, resources, prompts, and server configuration to surface a complete inventory.
  • Update human- and machine-facing docs and metadata (README, CLAUDE.md/AGENTS.md, server.json, package.json metadata, bunfig.toml, LICENSE, and CHANGELOG) to reflect the current surface.
  • Ensure idempotent changes; only modify artifacts that are out of sync, preserving correct data.

Quick Start

Run the polish-docs-meta skill to audit and polish your MCP server's docs and metadata.

Frequently Asked Questions about polish-docs-meta

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prepare MCP server documentation and metadata for release?

To prepare MCP server documentation for release, you audit and polish all docs and metadata to ensure ship readiness. This process updates README, CLAUDE.md, server.json, and package.json to reflect the current server surface area.

What does it mean to polish MCP server metadata for ship readiness?

Polishing MCP server metadata means scanning all tools, resources, and prompts to create a complete inventory, then idempotently aligning package.json, server.json, and documentation with the current state without altering correct data.

Can I safely update server.json and package.json without overwriting correct metadata?

Yes, you can safely update server.json and package.json metadata because the polishing process is idempotent. It checks the current state and only modifies artifacts that are out of sync, preserving data that is already correct.

When should I run an MCP documentation audit during the development lifecycle?

You should run an MCP documentation audit after implementation is complete, tests pass, and devcheck is clean. It is safe to run at any stage during development, release preparation, or publishing scenarios.

What is the best way to inventory MCP server tools and resources for documentation?

The best way to inventory MCP server tools and resources is to scan the server configuration and surface area. This captures all tools, resources, and prompts to update human-facing READMEs and machine-readable manifests.