GunSpec

All 39 single-call tools

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
    {  "name": "gunspec_search_docs",  "arguments": {    "question": "how should I handle a 429 rate limit"  }}
  3. 3

    The server answers

    Result
    json
    {  "query": "how should I handle a 429 rate limit",  "total": 109,  "results": [    {      "guideId": "faq",      "guideTitle": "Frequently asked questions",      "anchor": "faq-limits",      "title": "Limits and plans",      "trail": "Limits and plans",      "url": "https://docs.gunspec.io/en/faq#faq-limits",      "snippet": "**What counts as a request?** Every call that reaches a handler, including errors, counts against the daily cap and the monthly allowance. A call a limit refused with a 429 still counts against the daily cap but not the month. A `304 Not Mo…"    },    {      "guideId": "atlas-cost",      "guideTitle": "Stay inside the plan",      "anchor": "atlas-cost-stop",      "title": "Stop at zero, and at the first 429",      "trail": "Stop at zero, and at the first 429",      "url": "https://docs.gunspec.io/en/atlas/cost#atlas-cost-stop",      "snippet": "A refusal is not a hiccup to retry through. Nothing is served until the limit resets, a call made before then is refused, and a free key that keeps calling is paused. A job that fails politely does five things. - Read `X-Daily-Remaining` an…"    },    {      "guideId": "atlas-cost",      "guideTitle": "Stay inside the plan",      "anchor": "atlas-cost-month",      "title": "What counts towards the monthly limit",      "trail": "What counts towards the monthly limit",      "url": "https://docs.gunspec.io/en/atlas/cost#atlas-cost-month",      "snippet": "The plan's monthly allowance is enforced, not just reported. These are the rules, so a script can plan around them. - The month belongs to the account. Every key on it draws on one pool, so a second key does not double the plan, while the d…"    }  ]}

    Captured from the live API on Oct 22, 2026. Lists and long text are shortened for display.

Related references

Arguments

  • stringrequired

    The question, in the user's own words.

  • integer

    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.

json