Repository navigation
docs: write the README's examples in Kaiten's vocabulary - #4
Closed
Alex (Alexkuva) wants to merge 2 commits into
Closed
Alex (Alexkuva) wants to merge 2 commits into
Alex (Alexkuva) wants to merge 2 commits into
Conversation
The README spoke of plans and seats, and its examples ran on Acme, a customer no Kaiten dataset has. It now says License, and its examples run on Kaiten Sushi Shop, the demo dataset `task quickstart` seeds and the e2e suite reads: Ninja Osaka moves to Premium, and Starter gets a version with 25 menu items. Both calls were run against that dataset. A sentence under the tools table says what the `plan` and `license` arguments are: a License family, and an exact License version. Two argument descriptions and a docstring drop Acme the same way. Signed-off-by: Alexandre Bergere <alexandre.bergere@kaiten.sh> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
7 tasks done
backtrack5r3 (tomflenner)
approved these changes
Oct 22, 2026
7 tasks done
Contributor
Author
|
Replaced by #8: the same commit, taken again on top of main. Updating this branch from main added a merge commit without a sign-off, which fails DCO and only a history rewrite could remove. |
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.
What does this PR change?
The README speaks Kaiten's vocabulary, and its examples run on Kaiten Sushi Shop, the demo dataset
task quickstartseeds:kaiten_update_instance(instance="ninja-osaka-prod", plan="premium", extend_license_days=365);kaiten_save_license(new_version_of="starter", grants={"menu-items": 25}).planandlicensearguments are: a License family, whose current version an instance moves to, and an exact License version.views.pydocstring drop Acme the same way.Why?
Kaiten's vocabulary says License, never plan, and the docs' running example is Kaiten Sushi Shop. A reader who follows the README on a seeded stack can now find every name it uses.
The
planargument itself is left as it is. Renaming it would change the tools' input schema, so it is a decision for the tools' design, not for this PR.Testing
task quickstartof kaiten main through an MCP client:kaiten_update_instanceanswersupdated:ninja-osaka-prodonpremium-v2, with its License end pushed out;kaiten_save_licenseanswerscreated:starter-v2, with Starter's grants copied,menu-itemsat 25, and no instance on it.kaiten_get_usage(min_percent=80)andkaiten_evaluate_flags(instance="sakura-tokyo-prod"), unchanged, were run too. The second explains the off dashboard: its rule readsorderCount, which the evaluation context lacks.uv run ruff check .,uv run ruff format --check .,uv run pytest: 56 passed.uv run pytest -m e2eagainst the same stack: 5 passed.Checklist
CONTRIBUTING.md.Signed-off-byline.🤖 Generated with Claude Code · ✅ Tested and approved by Alex (@Alexkuva), maintainer