The AGENTS.md file contains a valuable "Query Strategies" section with examples of how an agent should use the knowledge base query tool. This contextual information is currently disconnected from the tool's definition.
To make the tools more self-documenting and provide clearer guidance to future agents, we will embed these usage examples directly into the openapi.yaml specification for the query_documents tool.
Acceptance Criteria
- The
openapi.yaml file is modified.
- The
requestBody for the POST /documents/query endpoint is enhanced with an examples section.
- The examples are sourced from the "Query Strategies" section of
AGENTS.md, demonstrating:
- A broad, conceptual query.
- A query narrowed down to a specific component.
- A query targeting a specific content type (e.g.,
-t guide).
- This enhancement makes the tool's intended usage clearer directly from its OpenAPI definition.
The
AGENTS.mdfile contains a valuable "Query Strategies" section with examples of how an agent should use the knowledge base query tool. This contextual information is currently disconnected from the tool's definition.To make the tools more self-documenting and provide clearer guidance to future agents, we will embed these usage examples directly into the
openapi.yamlspecification for thequery_documentstool.Acceptance Criteria
openapi.yamlfile is modified.requestBodyfor thePOST /documents/queryendpoint is enhanced with anexamplessection.AGENTS.md, demonstrating:-t guide).