A project-finishing command for improving documentation, code comments, package details, GitHub metadata, and release notes. A README is the main guide people see when they visit a code project.

Use it to review and improve a project's README, API documentation, examples, comments, package metadata, GitHub topics, and changelog.

It helps remove unclear setup instructions, missing project information, incomplete documentation, and messy packaging details.

polish — Command by SylphxAI

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add commands/sylphxai/coderag/polish

Clone the repo

git clone --depth 1 https://github.com/SylphxAI/coderag

Made for: Claude Code.

Per session 15 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 469 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00015	$0.00469
Opus 5	$0.00008	$0.00234
Sonnet 5	$0.00003	$0.00094
Haiku 4.5	$0.00002	$0.00047

Measured yesterday against content hash cd0120a8b30d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

polish scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/polish.md · 89 lines

What it actually says

Polish Project

Make project professional, welcoming, and well-documented.

Scope

README:

Clear project description (what, why, how)
Installation instructions (tested)
Quick start example (copy-paste ready)
Key features (3-5 bullet points)
API overview
Links to full docs
Badges (build status, coverage, version, license)
Contributing guidelines link
License

Documentation:

API reference (all public functions)
Usage examples (common scenarios)
Tutorials (step-by-step guides)
Architecture overview
Troubleshooting guide
FAQ
Migration guides (if applicable)

Code Comments:

JSDoc for public APIs
Complex logic explained (WHY not WHAT)
Non-obvious decisions documented
Examples in comments where helpful

Packaging (package.json):

Accurate description
Relevant keywords (10-15)
Repository URL
Homepage URL
Bug tracker URL
Author info
License
Engines specified
Files field (only ship necessary)

GitHub Metadata:

Topics/tags (10-20 relevant tags)
Description (concise, searchable)
Website URL
Social preview image (if applicable)

Changelog:

Update CHANGELOG.md
Clear version history
Breaking changes highlighted
Migration instructions

Contributing:

CONTRIBUTING.md
Code of conduct
Development setup
Testing guidelines
PR process

Execution

Audit what exists vs what's missing
Update outdated content
Create missing documentation
Test all code examples
Verify all links work
Ensure consistency across docs

Quality Checks

README explains project in <5 min read
New user can get started in <10 min
All examples tested and work
No broken links
Search-friendly keywords
Professional presentation
Beginner-friendly

Report: What was added/updated, coverage improved.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

yesterday First seen · 89 lines · 15 tokens per session scan A cd0120a8b30d

Subscribe to this mod's changes

polish is a command published in the GitHub repository SylphxAI/coderag (12 stars, last pushed 6d ago), licensed MIT. It adds 15 tokens to every session and 469 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Backend and APIs Code review Git and workflow RAG code-search embeddings mcp tfidf vector-search

polish

Getting it into your agent

What it costs to keep this loaded

Grade A, and why

Nothing flagged

What it actually says

Polish Project

Scope

Execution

Quality Checks

What this file has done since we first saw it

Other commands, from other repositories

rp-build-cli

rp-investigate-cli

rp-oracle-export-cli

rp-reminder-cli

call-graph

index