Repository navigation
docs: align CLAUDE.md and make format with the code and CI - #256
Merged
Merged
Conversation
- The Key Patterns sample read hit["account_id"], which no search hit has; hits carry available_accounts, as README and MIGRATION show. It raised KeyError. - top_k caps the merged result (toolset.search slices hits[:top_k]), not per connector. - submit_feedback() goes through min(scope), the lowest account id, not the first. - Dev tools live in the dev extra, so the add command is uv add --optional dev. - CI type checks examples too; make format now does the same, so a clean local run cannot still fail CI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.com>
CLAUDE.md still described per-connector _search_actions / _execute_action tools, while the toolset uses one stackone_search_actions / stackone_execute_action pair across every account in scope. The Key Patterns example pinned the first hit's account but ran a hardcoded Linear action, so the account and action could come from different connectors. make format now type-checks examples, which needs the dev and examples extras. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.com>
CLAUDE.md conflicted in the Key Patterns example: this branch corrects it (search hits carry available_accounts and action_id) and main reformatted it with ruff 0.17's markdown formatting. Kept the corrected example, now formatted the way ruff expects. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.com>
submit_feedback() routes through the lowest account in scope, so the example could send feedback through a different account than the one that ran the action. Pass the same account_ids. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.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.
What
CLAUDE.md (also
AGENTS.md) had drifted from the code, andmake formatchecked less than CI does.hit["account_id"]hit["available_accounts"][0]["id"]account_id(toolset.pysearch returns the server's actions plussession_id); README and MIGRATION useavailable_accounts. The sample raisedKeyError.top_ktoolset.pyreturn [... for action in hits[:top_k]]; README and MIGRATION say the samesubmit_feedback()accounttoolset.pyaccount_ids=[min(scope)]; README and the docstring say lowest iduv add --dev pytestuv add --optional dev pytest[project.optional-dependencies].dev;--devwould create a separate[dependency-groups]tablemake formatty check stackone_aity check stackone_ai examplesuv run ty check examplesas its own stepHow verified
uv run ty check stackone_ai examples: All checks passed.Gates (head 32e0fed)
action_idon its own account, the stale per-connector meta tool names are nowstackone_search_actions/stackone_execute_action, the Commands and Testing lines say where examples are type-checked, and theformathelp says it needsmake install extras=1Requested by guillaume@stackone.com in Slack (repo audit thread).
🤖 Generated with Claude Code
Summary by cubic
Aligns
CLAUDE.mdandmake formatwith the actual code and CI behavior.stackone_search_actions/stackone_execute_action, one pair across every account in scope, not per-connector.KeyError: hits carryavailable_accountsandaction_id, and the example now runs the hit's own action on its own account, scopingsubmit_feedback()to that same account.top_kto cap the whole merged result, matchingtoolset.py'shits[:top_k]slice.submit_feedback()to use the lowest account id in scope (min(scope)), not the first account.uv add --optional dev pytest, since dev tools live in thedevextra.examplestomake formattype checks, matching CI so a clean local run won't fail CI.Documentation and Makefile only; no runtime behavior changes.
Written for commit e702e5b. Summary will update on new commits.