docs: repair procedures orphaned by API ceremony rewrite - #41
Merged
Merged
Conversation
Follow-up review after #33-#40 landed: - Rewrite the Rego how-to verification against the current stdio tutorial; #34 deleted the in-process client it patched. - Show the literal tools/list wire schemas in the MCP reference (inlined field shapes, result: true) and fix the composite example's root output shape (field items, not a bare list root). - Add MaxIntermediateValueBytes to SECURITY.md's limit inventory. - Make disable-capabilities verification executable-shaped with exact inputs and expected tool errors. - Style repairs on new text: conditions before code, descriptive reference voice, removed 'normally'/'common'/'output universe', terminology and link fixes.
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
1 participant
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.
Summary
Follow-up independent docs review after #33–#40. Same three-axis wave as #32 plus functional reproduction in the review itself.
Blocking defect fixed
callTool,go run ., theexecuteprint path), butuse-rego-authorization.mdstill instructed patching it. Rewritten against the actual stdio tutorial: build, reload in the agent, run exactdef main():programs for the allowed and denied cases.Accuracy
mcp-tools.mdclaimed literaltools/listschemas but showed normalized equivalents — now byte-matches the advertised wire values (inlined field shapes under bothitems,"result": true), established from a livetools/listcapture.list[...]while indexingresponse["items"]— a bare list root isErrInvalidRegistration; prose now names the root fielditems.SECURITY.mdlimit inventory now includesMaxIntermediateValueBytes(feat(worker): bound intermediate native results #36) and uses the canonical exposure sentence.go getprose no longer claims the MCP SDK comes from its default branch.Style / Diátaxis (in-place)
public-api.mdprocedural passages rewritten in neutral reference voice (no facts removed).disable-capabilities.mdverification split into numbered executable checks with exact inputs/expected errors.normally,common) and new jargon (output universe); terminology regressions fixed; README documentation list gained the missing Rego how-to link.Deliberately not done (consistent with the #32 scope decision): named-agent tutorial path, relocating tutorial explanation, moving the MCP recovery section, removing README's assembly snippet.
Validation
moon run docs:build(strict) andgo test ./... -count=1pass.CommandTransportstanding in for the agent): tutorial program compiles as pasted and returns{"result":{"count":2,"key":"alpha"}}; Rego how-to allowed/denied cases reproduce{"result":{"count":2,"key":"alpha"}}/permission deniedexactly (including the embed variant); disable how-to checks reproduce[]/capability not found/invalid programexactly.