Skip to content

docs: plain English for the long docs, and keep the npm lock's version in step - #197

Merged
ciaransweet merged 5 commits into
mainfrom
docs/small-fixes
Oct 16, 2026
Merged

ciaransweet merged 5 commits into
mainfrom
docs/small-fixes

Conversation

@ciaransweet

@ciaransweet ciaransweet commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

A second plain-English pass over the docs, after #139, plus four small fixes to the docs and release config.

Plain English

docs/CONSUMING.md and docs/SESSION-STATE.md follow the same rules #139 used: short sentences, one idea each, and em-dash chains and semicolon lists turned into sentences, bullets or tables. #139 only lightly touched CONSUMING, and never touched SESSION-STATE.

Counted in prose, outside code blocks:

File em-dashes sentences over 40 words semicolons
docs/CONSUMING.md 111 to 0 11 to 0 30 to 17
docs/SESSION-STATE.md 28 to 0 12 to 0 13 to 0
README.md 6 to 0 0 to 0 3 to 3

SESSION-STATE keeps three em-dashes, all in code blocks that quote what the runtime actually prints. Every heading is unchanged, so links into either page still work.

Every function, class, environment variable and default the two pages name was checked against src/. Four things were wrong:

  • CONSUMING said SESSION-STATE has six worked scenarios. It has four.
  • CONSUMING said the web client speaks seven routes. There are eight since GET /threads.
  • CONSUMING called mcp_agent_api three layers, above a table of four.
  • The README listed the state route as GET /threads/{id}/state. It is GET /threads/{id}/state/{key}.

SESSION-STATE's Snapshot sketch now matches the code: a NamedTuple holding a TurnState.

History a reader no longer needs

  • CONSUMING §6, "Migrating off the in-repo workspace", is gone. It was for the two repos that copied the runtime before it was a package, and both have since moved to PyPI. "Upgrading to 0.11" is now §6. The README's mentions of the old packages went with it.
  • Release numbers cited as evidence in CONTRIBUTING. "The two most recent releases show it: 0.9.1… 0.9.0…" stopped being true several releases ago.
  • "now" and "has always" measured against versions nobody runs: a 422 that a client "now" gets, a container that "has always seen /mcp", what "every consumer got before this was configurable", what a host "has today".
  • The agui-events example's bug log ("What running it has caught"), which said "both of these" above a single bug fixed months ago. A line about "an earlier version of this example" went too.

The 0.10 to 0.11 upgrade guide stays: anyone still on 0.10 needs it.

Small fixes

  • The npm lock keeps its version. release-please bumped js/mcp-view/package.json but not package-lock.json, which was still at 0.10.3. The lock's two version fields are now extra-files, and caught up to 0.11.0 by hand.
  • CONTRIBUTING says which commit types release. docs does, on its own. build, so every dependency bump, does not.
  • The README says --install also writes AGENTS.md, and that every route answers 503 while the agent is not built.
  • docs/proposals/ is ignored. Local design notes were swept into pushed commits three times.

This is a docs commit, so it cuts 0.11.1, which also ships the fastapi and typer bumps merged today.

🤖 Generated with Claude Code

ciaransweet and others added 2 commits October 16, 2026 14:03
release-please now bumps js/mcp-view/package-lock.json too. CONTRIBUTING
says which commit types release, and the README covers AGENTS.md from
--install and the 503 while the agent is not built. docs/proposals/ is
ignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A second pass after #139: no em-dashes in prose, no sentence over 40
words, and three corrections. SESSION-STATE has four scenarios, not six;
the web client speaks eight routes, not seven; and the README named the
state route without its key.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ciaransweet ciaransweet changed the title docs: say what releases, keep the npm lock's version in step docs: plain English for the long docs, and keep the npm lock's version in step Oct 16, 2026
ciaransweet and others added 3 commits October 16, 2026 14:26
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The in-repo workspace migration (CONSUMING §6) and its README mentions,
release numbers cited as evidence, "now" and "has always" against
versions nobody runs, and a bug log in the agui-events example.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@ciaransweet
ciaransweet merged commit 7991742 into main Oct 16, 2026
4 checks passed
@ciaransweet
ciaransweet deleted the docs/small-fixes branch October 16, 2026 14:59
ciaransweet pushed a commit that referenced this pull request Oct 16, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.11.1](mcp-toolsets-runtime-v0.11.0...mcp-toolsets-runtime-v0.11.1)
(2026-10-16)


### Documentation

* plain English for the long docs, and keep the npm lock's version in
step
([#197](#197))
([7991742](7991742))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: ds-release-bot[bot] <116609932+ds-release-bot[bot]@users.noreply.github.com>
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.

1 participant