name the search-query concept in each q parameter description (ADR 0005) #757

Closed
opened 2026-10-13 21:18:38 +00:00 by hexajon · 0 comments
Owner

An agent reaches for query on a search tool; the canonical argument is q, the Forgejo and Gitea search API name. The call fails, because query is 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 q parameter's JSON Schema description name the concept an agent reaches for ("search query"), with an inline example, so an agent scanning the schema lands on q on the first call.

Fix

  • Audit the tools keyed by q: madt_search, madt_repos action=search, madt_issues action=search, and any other q.
  • Give each q a description that names the search-query concept and shows an example, anchored to the gh, tea, and API vocabulary.
  • No new did-you-mean entry, no alias, no rename (ADR 0005).

Acceptance

  • Each q description names the search-query concept with an example.
  • docs generate --verify passes.
  • The parity test still holds the canonical name q.
An agent reaches for `query` on a search tool; the canonical argument is `q`, the Forgejo and Gitea search API name. The call fails, because `query` is 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 `q` parameter's JSON Schema description name the concept an agent reaches for ("search query"), with an inline example, so an agent scanning the schema lands on `q` on the first call. ## Fix - Audit the tools keyed by `q`: madt_search, madt_repos action=search, madt_issues action=search, and any other `q`. - Give each `q` a description that names the search-query concept and shows an example, anchored to the gh, tea, and API vocabulary. - No new did-you-mean entry, no alias, no rename (ADR 0005). ## Acceptance - Each `q` description names the search-query concept with an example. - `docs generate --verify` passes. - The parity test still holds the canonical name `q`.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
sixfold-space/madtea#757
No description provided.