Searching the SmartZone guides

Claude can search the text of 23 RUCKUS SmartZone 7.2.0 guides with search_docs, then read a whole section with read_doc. It uses them for how a feature works, where it is in the web UI, requirements and limits, CLI commands, SNMP objects, upgrade steps and release-note known issues, and cites the guide and page. A search never contacts your controller. Both functions are on wifi and on switches, and work the same on either.

Which guides are searched?

All 23 are the SmartZone 7.2.0 guides. Where two revisions of a guide were available, the newer one is used. The id is what you pass in docs to narrow a search.

id	Guide
admin	Controller Administration Guide
ap-switch	Access Point and Switch Management Guide
netmgmt	Network Management Guide
troubleshooting	Troubleshooting and Diagnostics Guide
alarms-events	Alarms and Events Reference Guide
cli	Command Reference Guide
upgrade	Upgrade Guide
snmp-sz144-vsze	SNMP Reference Guide (SZ-144, vSZ-E)
snmp-vszh	SNMP Reference Guide (vSZ-H)
gpb-mqtt	Getting Started on the SZ GPB/MQTT Interface
aaa	AAA Interface Reference Guide
hotspot20	Hotspot 2.0 Interface Reference Guide
wispr	Hotspot WISPr Interface Reference Guide
tunnel-dataplane	Tunnel and Data Plane Guide
tunneling-interface	Tunneling Interface Reference Guide
sz144-getting-started	SmartZone 144 Getting Started Guide
sz144-quick-setup	SmartZone 144 Quick Setup Guide
vsz-getting-started	Virtual SmartZone Getting Started Guide
vsz-quick-setup	Virtual SmartZone Quick Setup Guide
vszd-quick-setup	Virtual SmartZone Data Plane (vSZ-D) Quick Setup Guide
release-notes	SmartZone 7.2.0 Release Notes
security-fixes	SmartZone 7.2.0 Security Vulnerability Fixes
r575-release-notes	R575 Access Point Release Notes

There are no ICX switch guides. Questions about ICX configuration or CLI are answered from the SmartZone guides only where those cover the switch management side.

Each guide is split into one section per entry in its table of contents, and sections longer than 6,000 characters are split again.

How does a search work?

search_docs({ query }) looks for sections containing every word of the query first. If none has them all, it tries again for any word, and the result says so in matched. Words are stemmed, so roaming also finds roam, and a match in a section’s title weighs five times a match in its text.

Argument	Type	Default	Notes
query	string	—	Required. 2–300 characters. Only the first 16 words are used
docs	array of guide ids	all 23	Restrict the search to these guides
limit	number	8	Hits returned, 1–25

It returns { matched, hits }:

Field	Meaning
matched	"all" (every word was found), "any" (no section had every word, so these match some of them) or "none"
hits	Best first: [{ id, doc, docTitle, title, path, page, snippet }]. path is the section’s place in the guide’s contents, page its page in the PDF, and snippet marks the matched words with **

The alarm, event and SNMP guides have thousands of short sections and can crowd a broad query; Claude narrows with docs when that happens.

Two lookups that are faster elsewhere

For what an alarm or event code means, Claude uses alerts.explain, a direct lookup in the same Alarms and Events guide. For which API endpoint does something, it uses search_endpoints: the API specs are not part of these guides. See Finding the right endpoint.

Reading a whole section

read_doc({ id }) returns one section by the id of a search hit: { id, doc, docTitle, title, path, page, text, totalChars, nextOffset?, prevId?, nextId? }.

Argument	Type	Default	Notes
id	number	—	Required. A hit id from search_docs
offset	number	0	Where to start in the section’s text
maxChars	number	8,000	500–20,000 characters per read

A section longer than maxChars comes in parts: pass nextOffset back as offset for the rest. prevId and nextId are the neighbouring sections in the same guide.

Errors

Error	From	Meaning
docs_not_loaded	both	”The SmartZone guides are not loaded on this server (npm run ingest:docs).” A server whose guide database is empty returns this instead of an empty result
docs_unavailable	both	The server has no database for the guides at all
not_found	read_doc	”No section 123; ids change when the guides are reloaded, so search again.” (with your id)

A section id is only stable until the guides are reloaded on the server, so Claude searches again rather than reusing an id from an old conversation.

Next steps

Finding the right endpoint Searching the API specs rather than the guides.

Endpoint notes Recording what the guides and specs don't say.

How code mode works Where search_docs runs, alongside the other helpers.