Skip to main content
Glama

Pipefork Management MCP

Get API

api_get
Read-only

Get one API by its stable API ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiIdYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
slugYes
statusYes
createdAtYes
updatedAtYes
descriptionYes
environmentsYes
allowedOriginsYes
hasProdDeploymentHistoryYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without description help. The description adds no further behavior such as error handling for unknown IDs or permission requirements, leaving it as pure restatement of the read semantics.

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?

A single short sentence with the operation and the lookup key front-loaded. Nothing redundant and nothing padded.

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?

An output schema exists, so return values need not be described. For a one-parameter read tool whose parameter is completely undocumented in the schema, the description should say more about what the stable API ID is and what happens on a miss; as written it is minimally adequate.

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 0% for the single apiId parameter, so the description must compensate. Saying 'stable API ID' is a useful hint that the identifier is the stable ID rather than a name or version-specific ID, but it gives no format, example, or lookup guidance.

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?

States a specific verb (Get) and resource (API) with singular scope, which implicitly separates it from sibling api_list and api_create. It is clear on its own, but it never names a sibling or any scoping condition to distinguish itself explicitly.

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

Usage Guidelines3/5

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

Usage is only implied: an agent infers it should call this when it already holds an API ID and wants a single record, and call api_list otherwise. No explicit when-to-use, prerequisite, or failure guidance is given.

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