Skip to main content
Glama

List Request Body Components

list_request_body_components
Read-only

List all reusable request body components (OpenAPI components/requestBodies) of an API specification. Optionally include usage counts showing how many endpoints link each component. Use this to browse or find an id; for one component with its schema use get_request_body_component. Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
specIdYesPublic ID (GUID) of the API specification
versionIdNoOptional version ID (GUID) to filter components by a specific version
includeUsageCountsNoInclude usage counts per component (default false, slightly slower)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

The readOnlyHint annotation already establishes that this is a read-only operation, and the description aligns by saying 'List'. The description adds the behavioral prerequisite that project context is required, which is useful. It does not elaborate on pagination or response shape, but the read-only nature is transparent.

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 three concise sentences, front-loads the primary purpose, and includes only relevant details about optional usage counts, the alternative tool, and the context prerequisite. No filler or redundancy.

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?

Given the tool has three parameters and no output schema, the description sufficiently covers the tool's purpose, the optional flag, the alternative get tool, and the project context prerequisite. It does not describe the response format, but for a list operation this is a minor omission and the provided context is otherwise complete.

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 descriptions cover all three parameters with 100% coverage, including specId, versionId filtering, and includeUsageCounts default behavior. The description adds extra meaning by clarifying that usage counts reflect how many endpoints link each component, which slightly enhances the schema-provided semantics.

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 'List' and the resource 'reusable request body components' scoped to an API specification. It also distinguishes itself from the singular get_request_body_component by noting it is for browsing or finding an id, and the sibling list_response_components/list_parameter_components context reinforces this differentiation.

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 says 'Use this to browse or find an id' and directs users to get_request_body_component for a single component with its schema. It also mentions the optional includeUsageCounts behavior and the prerequisite that project context is required, giving clear when-to-use guidance.

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