Skip to main content
Glama
StormXX
by StormXX

get_api_reference

Retrieve API reference documentation for any Rive runtime, including classes, methods, properties, and usage examples. Specify the runtime platform and optional class to get targeted reference details.

Instructions

Get API reference documentation for a specific Rive runtime. Shows available classes, methods, properties, and usage examples.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runtimeYesRuntime platform to get API reference for.
classNameNoSpecific class or component name to get reference for. Examples: "Rive", "RiveAnimation", "StateMachine"
includeExamplesNoInclude usage examples for the API. Default: true
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden of behavioral disclosure. It mentions that it 'shows' content, which implies a read-only operation, but it does not disclose potential behavior such as error handling, network dependencies, or any side effects. It adds minimal context beyond the tool's name and schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the action and resource. Every word earns its place, and there is no redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple documentation lookup tool, the description adequately conveys what it returns (classes, methods, properties, examples). It doesn't explain the overall structure or how to use the parameters together, but given the low complexity and rich schema, it is sufficiently complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema descriptions cover all three parameters (runtime, className, includeExamples) with clear details and examples. The tool description does not add meaning beyond the schema, so the baseline of 3 is appropriate when schema coverage is 100%.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb ('Get') and resource ('API reference documentation for a specific Rive runtime'), and lists what it shows. It implicitly distinguishes itself from sibling tools like get_runtime_guide or search_rive_docs by focusing on API reference, but it doesn't explicitly name alternatives, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. There is no mention of use cases, prerequisites, or exclusions. The only implied usage is 'when you need API reference', but that's not articulated clearly enough to be considered helpful guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/StormXX/rive-docs-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server