Skip to main content
Glama

Get Header Component

get_header_component
Read-only

Get one header component with its schema details and rowVersion. Level 'spec' (needs specId) or 'project'. Set includeUsage to also list what references it — spec level only; do that before deleting one. Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
levelYesWhich level to read: 'spec' or 'project'
specIdNoPublic ID (GUID) of the API specification — required for level 'spec'
versionIdNoOptional version ID (GUID) to narrow includeUsage to one version
componentIdYesPublic ID (GUID) of the header component
includeUsageNoAlso list what references this component — spec level only (default false)

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the description correctly avoids restating that. It adds valuable context about the return content (schema details and rowVersion) and the constraint that includeUsage is 'spec level only', which goes beyond the annotation. No contradictions found.

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?

Three concise sentences, each carrying distinct information: the core purpose, the level constraint, and the includeUsage tip. No filler words; the most important information is front-loaded. This is an excellent example of efficiency.

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

Completeness5/5

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

For a read-only getter with 5 parameters, the description covers the essential usage: what it returns, the level dependency, the includeUsage behavior, and the project context requirement. It does not need to explain output format since no output schema exists, and the readOnly annotation already covers safety. The description is complete for an agent to call correctly.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3. The description adds extra meaning by clarifying the level-specId relationship ('spec' needs specId) and the spec-only scope of includeUsage, which the schema does not fully express. This enriches the parameter semantics beyond the schema.

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 resource 'header component', and specifies it returns schema details and rowVersion. It also distinguishes itself from list_header_components by saying 'one' component, making its purpose unmistakable.

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

Usage Guidelines4/5

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

The description gives concrete guidance on when to use includeUsage ('do that before deleting one') and clarifies the level parameter ('spec' needs specId). It mentions 'Requires project context' as a prerequisite, but it does not explicitly compare with sibling tools like list_header_components or get_parameter_component, so alternatives are not named.

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.

TDQS

A3.9/5.0
Disambiguation4/5

The tools are mostly distinct with clear descriptions. Some pairs like get_header_policies vs get_resolved_headers or get_environment_verification vs get_monitoring_sync_status could be slightly confusing, but the descriptions clarify scope and purpose.

Naming Consistency5/5

All tools follow a consistent snake_case verb_noun pattern (get_, list_, create_, update_, manage_, etc.). Even the few bare verbs like 'search' and 'set_context' are consistent with the naming scheme.

Tool Count1/5

With 165 tools, the server is extremely heavy. This far exceeds the 'too many' threshold of 25+, making it difficult for an agent to navigate and select the right tool efficiently.

Completeness5/5

The tool surface covers a very broad API lifecycle domain: specs, environments, test cases, monitors, mock servers, security, governance, documentation, and team management. Read and write operations are present across most areas, with no obvious missing core functionality.

Resources