Skip to content

docs: comprehensive accuracy and completeness pass on public docs - #234

Merged
timesler merged 1 commit into
mainfrom
copilot/update-public-docs
Jun 28, 2026
Merged

docs: comprehensive accuracy and completeness pass on public docs#234
timesler merged 1 commit into
mainfrom
copilot/update-public-docs

Conversation

Copilot AI commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

The public docs had several gaps and inaccuracies relative to the actual implementation: the compression level table described behavior vaguely rather than showing the actual <tool> tag format; TOON was referenced but never explained; the llm subcommand was fully implemented but absent from the docs; Python/TypeScript API reference tables were missing ~half their public exports; and the LLM design doc gave no indication of what was already shipped.

Changes by file

  • concepts/how-it-works.md — Replace vague compression level descriptors with the actual <tool>name(args): description</tool> format at each level. Add schema response format section (always full description + JSON Schema regardless of active level).

  • concepts/configuration.md — Add TOON section (Token-Oriented Object Notation — what it is and all four language tabs). Complete exclude_tools across all language tabs. Add --multi-server name=command CLI section. Document --config file usage and the --server-name incompatibility constraint.

  • reference/cli.md + usage/cli.md — Document mcp-compressor llm subcommand (status, pull, remove, test) which was fully implemented but entirely absent from the docs. Include all options, examples, and cache directory locations.

  • modules.md — Expand Python API table from ~12 to 30+ entries with categorized sections (client/proxy, config types, Just Bash, compression helpers, OAuth, MCP config). Expand TypeScript table similarly with adapters and type exports.

  • reference/sdk.md — Add CompressorClient options table and CompressorProxy methods table mapping every option/method across Python/TypeScript/Rust. Full import examples for both languages.

  • llm-assist-design.md — Add implementation status admonition at the top: llm CLI management commands are shipped; SDK llmAssist config and active-assist features are still planned.

- concepts/how-it-works.md: accurate compression level table with actual
  <tool> tag format at each level; document schema response format
- concepts/configuration.md: explain TOON (Token-Oriented Object
  Notation), add exclude_tools in all language tabs, add --multi-server
  CLI example, add --config note about server-name incompatibility
- reference/cli.md: add llm management subcommand with status/pull/remove/
  test sub-subcommands, all options, examples, and cache location details;
  clarify --auth values
- usage/cli.md: add llm management commands section
- modules.md: complete Python exports table (all 30+ public symbols);
  complete TypeScript exports table with all adapters and helpers
- reference/sdk.md: expand shared concepts table, add CompressorClient
  options table, add CompressorProxy methods table, full Python/TypeScript
  import examples
- llm-assist-design.md: add implementation status admonition box
  distinguishing implemented CLI from planned SDK/feature work
@atlassian-cla-bot

Copy link
Copy Markdown

Thank you for your submission! Like many open source projects, we ask that you sign our CLA (Contributor License Agreement) before we can accept your contribution.
If your email is listed below, please ensure that you sign the CLA with the same email address.

The following users still need to sign our CLA:
❌Copilot

Already signed the CLA? To re-check, try refreshing the page.

Copilot AI changed the title docs: comprehensive review and improvement of public documentation docs: comprehensive accuracy and completeness pass on public docs Jun 28, 2026
Copilot AI requested a review from timesler June 28, 2026 18:45
@timesler
timesler marked this pull request as ready for review June 28, 2026 19:13
Copilot AI temporarily deployed to atlassian-mcp-integration June 28, 2026 19:13 Inactive
@timesler
timesler temporarily deployed to atlassian-mcp-integration June 28, 2026 19:13 — with GitHub Actions Inactive
@timesler
timesler merged commit d664676 into main Jun 28, 2026
29 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants