Search the GunSpec documentation

• gunspec_search_docs
• Explorer
• Read-only

Searches the GunSpec documentation guides and returns the sections that answer a question, best first, each with a snippet and a link. Use this tool whenever the user asks how something works or how they should do something with GunSpec - rate limits and retries, pagination, caching and ETags, authentication and keys, webhooks, errors and what a reason means, plans and pricing, data quality - instead of answering from memory. Then call gunspec_read_docs with the guide and anchor of the best hit to read it in full. A question the documentation does not cover returns no results, which means the answer is not in the docs rather than that a near-enough one should be given.

Example usage

1. 1

   A person asks

   • How should I handle rate limiting when calling the GunSpec API?
2. 2

   The assistant calls the tool

   tools/call

   json

   1{2  "name": "gunspec_search_docs",3  "arguments": {4    "question": "how should I handle a 429 rate limit"5  }6}

3. 3

   The server answers

   No captured answer is available for this tool yet.

Related references

Arguments

• questionstringrequired

  The question, in the user's own words.

• limitinteger

  How many sections to return. 8 by default.

  Range

  1 – 25

  Sent as

  ?limit=

Each argument is sent to GET /v1/docs/guides/search 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.