Core tools reference
These are the tools every user gets, with no feature flags enabled: they let
Claude find any RUCKUS One API operation, call it on your tenant, search the
RUCKUS One guides, choose between your tenants, and run common multi-step jobs
such as RF analysis and topology diagrams. You don’t call them directly — Claude
does, from inside code_mode — but
knowing what exists helps you ask for the right thing.
Discovery primitives
Section titled “Discovery primitives”| Tool | What it does |
|---|---|
list_tag_groups | Lists the top-level groups of the RUCKUS One API tag taxonomy |
list_tags | Lists tags within the taxonomy — the way into a subject area |
search_endpoints | Keyword search across every operation in the bundled API index |
list_endpoints_by_tag | Every operation carrying a given tag |
get_endpoint_details | Full schema for one operation, plus curated caveats and any saved notes |
save_endpoint_note | Attach a note to an endpoint — private to you, resurfaced on later lookups. 5–500 characters, at most 10 per endpoint and 500 in total (too_many_notes_for_endpoint, too_many_notes). You can’t delete your own notes yet — ask support if you reach the limit |
search_endpoints results include hints — expected request body, response
shape and fields, pagination style, required parameters — so Claude usually
gets what it needs without a second round trip. Search covers body and response
property names too, so a query like “create venue with address” ranks endpoints
whose body actually has an address field.
Calling the API
Section titled “Calling the API”call_r1 is the workhorse. It substitutes {pathParam} placeholders,
builds the query string, attaches your bearer token, and sends the request.
Behavior worth knowing:
- HTTP errors return a response object rather than throwing —
okandstatustell the story. - A
401triggers exactly one refresh-and-retry. - A
429auto-retries for GET, PUT, and DELETE honoringRetry-After. POST and PATCH are not replayed automatically unless the call setsretryOn429: true. - Every response reports retry count and contributes to the run’s budget.
Documentation search
Section titled “Documentation search”search_docs is full-text, BM25-ranked search over three RUCKUS One
guides — 1,776 indexed sections in total:
| Guide | Sections | Topics |
|---|---|---|
| RUCKUS One Online Help | 1,505 | 544 |
| RUCKUS One MSP Guide | 240 | 78 |
| RUCKUS One Subscriptions & Licensing Guide | 31 | — |
Results carry the section path, title, and a snippet. The two HTML-sourced guides also carry a link to the live topic, so an answer can cite where it came from; the licensing guide is PDF-sourced and cites a page number instead.
Use it when the question is “how does RUCKUS One do X?” rather than “which endpoint returns X?” — and note that MSP and licensing questions are in scope, not just the main user guide.
Connections
Section titled “Connections”list_connections returns the R1 connections enabled on your account —
{id, label, tenantId, region, isDefault}, never secrets — so Claude can pick a
tenant when you have more than one. See
Multiple connections.
Task helpers
Section titled “Task helpers”These compose the primitives above into common multi-call workflows, so Claude doesn’t have to reinvent them each time:
| Helper | What it does |
|---|---|
list_venue_wlans | Every WLAN at a venue, resolved across the calls that takes |
await_request | Polls an asynchronous R1 operation to completion |
analyze_rf | RF analysis for a venue, or single-AP airtime when given an AP MAC |
diagram_topology | Builds layered L1 (cabling), L2 (forwarding), and L3 (routing) diagrams of a venue, each with its own confidence note — Mermaid by default, or D2 and draw.io |
The helper catalog is generated from the live tool registry, so it’s always in sync with what the server actually offers.
Many R1 writes are asynchronous: the call returns 202 with a request id, and
the work happens afterwards. await_request polls that id until it reaches a
terminal state, for 60 seconds by default (settable from 1 to 120). R1
answers 404 for an activity it has accepted but not yet made resolvable, so a
404 means not yet rather than failed — the poll continues. See
Limits and quotas.
Beyond the core
Section titled “Beyond the core”Everything else — FastIron docs, webhook analytics, live CLI, test beds, venue copy, GraphQL, probe, Data Studio — is behind a feature flag you enable per account.
Enabling any feature also adds get_reference, which reads the curated
reference documents that ship with the server — verified CLI patterns, GraphQL
schemas, and workflow playbooks. The listing is filtered to the features you
have on. See Bundled reference docs.