get_api
Focused: just the typed API (inputs, two-way models, outputs and referenced types) of a component, by slug.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes |
Focused: just the typed API (inputs, two-way models, outputs and referenced types) of a component, by slug.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
There are no annotations, so the description must fully disclose behavioral traits. It describes what is returned (typed API content) but does not mention side effects, authentication, rate limits, error handling, or whether the operation is read-only.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: a single 12-word sentence. It is front-loaded with the key information. However, it could be slightly more structured by including a brief usage condition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has no output schema and no annotations, the description should provide a complete picture. It covers the output content but omits any error conditions, parameter constraints, or return format details, leaving significant gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With schema description coverage at 0%, the description adds minimal meaning beyond the schema. It clarifies that the 'name' parameter is a 'slug', but does not explain the format or how to obtain it. More detail would help heavily.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool returns the typed API of a component, listing specific elements like inputs, models, outputs, and referenced types. It uses a specific verb ('get') and resource ('API'), but it does not explicitly distinguish itself from sibling tools like get_docs, which may also provide API documentation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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 such as get_docs or list_components. It does not mention prerequisites, context, or exclude cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool has a clearly distinct purpose: listing different resource types, getting specific documentation, and keyword search. No overlap exists.
Tools consistently use 'get_' and 'list_' prefixes, but 'search' deviates slightly from the verb_noun pattern, though it remains predictable.
Seven tools is well-scoped for a component library server, covering listing, searching, and retrieving details without unnecessary bloat.
The tool surface covers the full workflow: discover resources via list and search, then get detailed docs or API. No obvious gaps for the stated purpose.