name the search-query concept in each q parameter description (ADR 0005) #757
Labels
No labels
breaking
bug
documentation
enhancement
epic
good first issue
help wanted
refactoring
resolution/duplicate
resolution/invalid
resolution/wontfix
security
severity/critical
severity/high
severity/low
severity/medium
status/abandoned
status/blocked
status/needs-decision
status/needs-info
status/needs-verification
testing
upstream
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
sixfold-space/madtea#757
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
An agent reaches for
queryon a search tool; the canonical argument isq, the Forgejo and Gitea search API name. The call fails, becausequeryis a semantic synonym, not a typo, so the bounded did-you-mean does not guess it (ADR 0005: tighten, never broaden).Per the ADR 0005 recipe, the fix is proactive, at the schema description, not the matcher.
What
Make each search-style
qparameter's JSON Schema description name the concept an agent reaches for ("search query"), with an inline example, so an agent scanning the schema lands onqon the first call.Fix
q: madt_search, madt_repos action=search, madt_issues action=search, and any otherq.qa description that names the search-query concept and shows an example, anchored to the gh, tea, and API vocabulary.Acceptance
qdescription names the search-query concept with an example.docs generate --verifypasses.q.