docs: comprehensive accuracy and completeness pass on public docs - #234
Merged
Conversation
- 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
|
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. 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 created this pull request from a session on behalf of
timesler
June 28, 2026 18:45
View session
timesler
approved these changes
Jun 28, 2026
timesler
approved these changes
Jun 28, 2026
timesler
marked this pull request as ready for review
June 28, 2026 19:13
timesler
temporarily deployed
to
atlassian-mcp-integration
June 28, 2026 19:13 — with
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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; thellmsubcommand 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). Completeexclude_toolsacross all language tabs. Add--multi-server name=commandCLI section. Document--configfile usage and the--server-nameincompatibility constraint.reference/cli.md+usage/cli.md— Documentmcp-compressor llmsubcommand (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:llmCLI management commands are shipped; SDKllmAssistconfig and active-assist features are still planned.