Skip to main content
Glama

get-component-props

Retrieve TypeScript interface definitions with JSDoc comments for Salt Design System components to understand their props and API structure.

Instructions

Get the props/API definition for a specific Salt component. Returns the TypeScript interface with JSDoc comments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
componentYesComponent name in kebab-case (e.g. 'button', 'combo-box') or PascalCase (e.g. 'Button', 'ComboBox')
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the return format ('TypeScript interface with JSDoc comments'), which is useful, but fails to address other critical aspects such as error handling (e.g., what happens if the component doesn't exist), performance considerations, or any side effects. This leaves significant gaps in understanding the tool's behavior.

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, well-structured sentence that efficiently conveys the tool's purpose and return value without unnecessary details. It is front-loaded with the core action and resource, making it easy to parse and understand quickly.

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

Completeness3/5

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

Given the tool's low complexity (one parameter, no output schema, no annotations), the description is minimally adequate. It explains what the tool does and what it returns, but lacks details on error conditions, performance, or usage context. For a simple read operation, this is acceptable but leaves room for improvement in guiding the agent effectively.

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 description coverage is 100%, with the parameter 'component' fully documented in the input schema. The description does not add any additional semantic information beyond what the schema provides, such as examples of valid component names or constraints. However, since the schema adequately covers the parameter, the baseline score of 3 is appropriate.

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 the verb ('Get') and resource ('props/API definition for a specific Salt component'), and specifies the return type ('TypeScript interface with JSDoc comments'). However, it does not explicitly differentiate from sibling tools like 'get-component-example' or 'get-salt-docs', which may also retrieve component-related information, leaving some ambiguity about uniqueness.

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 such as 'get-component-example' or 'search-components'. It lacks context about prerequisites, typical use cases, or exclusions, leaving the agent to infer usage based solely on the tool name and description.

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/feesch/salt-mcp'

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