Skip to content
R1-MCP
Get Support

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.

ToolWhat it does
list_tag_groupsLists the top-level groups of the RUCKUS One API tag taxonomy
list_tagsLists tags within the taxonomy — the way into a subject area
search_endpointsKeyword search across every operation in the bundled API index
list_endpoints_by_tagEvery operation carrying a given tag
get_endpoint_detailsFull schema for one operation, plus curated caveats and any saved notes
save_endpoint_noteAttach 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.

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 — ok and status tell the story.
  • A 401 triggers exactly one refresh-and-retry.
  • A 429 auto-retries for GET, PUT, and DELETE honoring Retry-After. POST and PATCH are not replayed automatically unless the call sets retryOn429: true.
  • Every response reports retry count and contributes to the run’s budget.

search_docs is full-text, BM25-ranked search over three RUCKUS One guides — 1,776 indexed sections in total:

GuideSectionsTopics
RUCKUS One Online Help1,505544
RUCKUS One MSP Guide24078
RUCKUS One Subscriptions & Licensing Guide31

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.

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.

These compose the primitives above into common multi-call workflows, so Claude doesn’t have to reinvent them each time:

HelperWhat it does
list_venue_wlansEvery WLAN at a venue, resolved across the calls that takes
await_requestPolls an asynchronous R1 operation to completion
analyze_rfRF analysis for a venue, or single-AP airtime when given an AP MAC
diagram_topologyBuilds 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.

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.