Skip to main content
Glama

Get Parameter Component

get_parameter_component
Read-only

Get one reusable parameter component with its schema details and rowVersion. Set includeUsage to also list the endpoints referencing it — do that before deleting one. Use this when you already have the component id; to browse them or find an id use list_parameter_components. Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
specIdYesPublic ID (GUID) of the API specification
componentIdYesPublic ID (GUID) of the parameter component
includeUsageNoAlso list what references this component (default false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The readOnlyHint annotation already signals no side effects, so the description doesn't need to repeat that. It adds useful context about the includeUsage parameter's purpose (checking endpoints before deletion), which aids in understanding the tool's behavior. No contradictions with annotations.

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 compact and to the point, with no redundant wording. It conveys all essential information in two sentences and a short clause, making it easy for an agent to parse quickly.

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?

The description indicates what is returned (schema details and rowVersion) but does not enumerate all response fields or error scenarios. Given the tool's simplicity and the presence of sibling tools for listing, this is sufficient for an agent to know when and how to invoke it correctly.

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 already covers all three parameters with descriptions, achieving 100% coverage. The description adds marginal value by explaining the purpose of includeUsage (listing referencing endpoints) and implies that specId and componentId are identifiers needed for lookup. No additional semantics beyond schema are necessary.

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

Purpose5/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 the specific resource 'reusable parameter component', including what is returned (schema details and rowVersion). It distinguishes this tool from list_parameter_components and other component getters by focusing on a single component by ID.

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

Usage Guidelines5/5

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

Explicitly states when to use this tool ('when you already have the component id') and when to use the alternative ('to browse them or find an id use list_parameter_components'). It also mentions a precondition ('Requires project context') and provides a practical hint about includeUsage before deletion.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources