Core tools reference
These are the tools on the r1 object inside
code_mode that every user gets, with no
feature flags enabled. You don’t call them directly — Claude does — 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 |
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. - Every response reports retry count and contributes to the run’s budget.
Documentation search
Section titled “Documentation search”search_docs is full-text search over the RUCKUS One online user guide —
544 topic pages, indexed and BM25-ranked. Results carry the section path,
title, a snippet, and a link to the live user-guide topic, so an answer can
cite where it came from.
Use it when the question is “how does RUCKUS One do X?” rather than “which endpoint returns X?”.
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 a topology diagram of the network |
The helper catalog is generated from the live tool registry, so it’s always in sync with what the server actually offers.
Beyond the core
Section titled “Beyond the core”Everything else — FastIron docs, webhook analytics, live CLI, test beds, GraphQL, probe, Data Studio — is behind a feature flag you enable per account.