Read a GunSpec documentation guide
Returns one GunSpec documentation guide as Markdown. Pass the anchor of a section from gunspec_search_docs to read just that section, which is what an answer usually needs; omit it for the whole page, which can run to tens of kilobytes. Quote what this returns rather than paraphrasing from memory, and cite the url. Call gunspec_search_docs first unless the guide id is already known.
Example usage
- 1
A person asks
- Read the GunSpec caching guide and tell me how long I may keep a firearm record.
- 2
The assistant calls the tool
tools/calljson{ "name": "gunspec_read_docs", "arguments": { "guide": "caching", "anchor": "caching-policy" }} - 3
The server answers
No captured answer is available for this tool yet.
Related references
Arguments
- stringrequired
The guide id, e.g. "caching", "pagination", "errors" or "rate-limits".
- string
A section anchor from gunspec_search_docs. Omitted, the whole page is returned.
- Sent as
- ?anchor=
Each argument is sent to GET /v1/docs/guides/{id} as the parameter shown, so the same request can be made to the API directly, with your key, if you want to shape what comes back.