Tools Reference
Every tool exposed by the Hyperstack Docs MCP Server, with parameters and example prompts.
This page documents every tool exposed by the Hyperstack Docs MCP Server, including its parameters and example prompts.
All five tools are read-only. They retrieve and cite Hyperstack documentation and never change any resource. Your AI client selects and calls the right tool automatically based on your question, so in normal use you ask a question in plain language rather than invoking a tool by name.
Every result includes the absolute source URL of its documentation page (https://docs.hyperstack.cloud/docs/...), so the answer stays traceable to the published docs.
search_docs
Search the documentation for any concept, feature, API endpoint, or workflow. This is the primary tool and the one your client reaches for most.
Parameters
| Parameter | Required | Description |
|---|---|---|
query | Yes | The natural-language search query. |
resource_type | No | Narrows results to one product area: vm, cluster, volume, networking, billing, ai_studio, or hardware. |
limit | No | Number of results to return, from 1 to 20. Defaults to 5. |
Returns: A ranked list of matching pages. Each result includes the page breadcrumb, its source URL, and a relevant snippet.
Example prompts
How do I hibernate a Virtual Machine on Hyperstack?Search the Hyperstack billing docs for how credits work.
get_page
Retrieve the full content of a specific documentation page. Your client uses this after a search when it needs the complete page, such as a full parameter table or a code example.
Parameters
| Parameter | Required | Description |
|---|---|---|
path | Yes | The documentation URL or path to retrieve, such as https://docs.hyperstack.cloud/docs/virtual-machines/spot/ or docs/virtual-machines/spot. |
Returns: The full page content, with its title and source URL. If the page is not found, the tool suggests the closest matching pages.
Example prompts
Open the full Hyperstack spot Virtual Machines page and summarize the pricing rules.Get the complete Kubernetes cluster creation page.
list_sections
List the structure of the documentation, grouped by section. Use it to browse what exists in a product area before searching.
Parameters
| Parameter | Required | Description |
|---|---|---|
filter | No | Limits the listing to one product area: vm, cluster, volume, networking, billing, ai_studio, hardware, or all. Defaults to all. |
Returns: A table of contents grouped by section, with a link to each page.
Example prompts
List everything in the Hyperstack networking documentation.Show me the table of contents for AI Studio.
lookup_error
Explain a Hyperstack API error and point to the fix. Pass an HTTP status code, an error_reason value, or the raw error message.
Parameters
| Parameter | Required | Description |
|---|---|---|
error_message | Yes | The HTTP status code, error_reason value, or raw error text, such as 401, not_found, or out of stock. |
context | No | What operation was being attempted, to sharpen the answer. |
Returns: The cause of the error, the recommended fix, and a link to the full error reference. If there is no exact match, the tool returns the closest documentation.
Example prompts
What does a Hyperstack 409 already_exist error mean and how do I fix it?I got a "not_found" error creating a VM. What went wrong?
get_flavor_info
Return GPU flavor specifications. Use it when comparing hardware or planning a deployment.
Parameters
| Parameter | Required | Description |
|---|---|---|
query | No | A natural-language hardware query, such as fastest H100, cheapest with NVLink, or 8 GPU setup. |
gpu_model | No | Filters to one GPU model: B200, H200, H100, A100, L40, RTX PRO 6000, RTX A6000, or RTX A4000. |
Returns: The flavor specifications for the matched GPU family. When your query names more than one model, the tool returns the families side by side for comparison.
Example prompts
Compare the A100 and H100 flavors on Hyperstack.What is the largest H100 flavor available?