docs: fix the synth command, and show the async tool the scaffold writes - #42
Merged
Merged
Conversation
Two things a reader copies that do not work. The AWS synth invocation passed one toolset in `imageTags`. Every component needs a tag, `index-aws` and `chat` included, so the documented command fails with `no image tag for 'index-aws'`. Both README and CLAUDE.md now build the map the way CI does. The example tool in "Adding a toolset" was sync, directly above prose telling the reader to use async for I/O. The example is what gets copied. The contract test now refuses a sync tool that does blocking I/O, so say that where the other gates are listed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Two things a reader copies that do not work. Found by checking every command and path in
README.mdandCLAUDE.mdagainst the repo.The AWS synth command fails as written
Both files documented it with one toolset in
imageTags:Every component needs a tag,
index-awsandchatincluded, so that raises:Both now build the map the way
ci.ymlalready does, and say what happens if one is missing. Verified: the corrected command synthesises.The tool example was sync
"Adding a toolset" showed
def do_something(...)directly above prose telling the reader to writeasync deffor I/O. The example is what gets copied. It is now async, which is also what the scaffold generates since #41.The contract test refuses a sync tool that does blocking I/O since #40, so that is now listed with the other gates rather than left implicit.
What else was checked
./scripts/*reference existsmcp-serve-local: thehellocall and thecredential-democall with its header both return what the README showsNothing else was wrong.
🤖 Generated with Claude Code