Skip to main content
Glama

PacketFabric

pf_describe_endpoint

Read-only

Show parameters, request body schema and response shape for one endpoint. Call this before pf_call_endpoint for anything you haven't used yet.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operation_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered by structured data. The description adds a little context by naming the three things it surfaces, but discloses nothing further about behavioral traits. With annotations carrying the load, a 3 is appropriate.

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?

Two sentences, zero waste. The capability statement is front-loaded ahead of the workflow instruction, making the important information land first.

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?

An output schema exists, so the description need not explain return values, and it correctly focuses on purpose and workflow. The only gap is that operation_id's origin is never addressed, which slightly limits standalone completeness.

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

Parameters2/5

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

Schema description coverage is 0% and there is one required parameter (operation_id) whose meaning and provenance are never explained in either the schema or the description. A discovery tool depends on the agent knowing where operation_id comes from (e.g. pf_search_endpoints), and the description does not say so.

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 states a specific verb and resource: it returns parameters, request-body schema, and response shape for a single endpoint. This clearly distinguishes it from pf_call_endpoint (which executes) and pf_search_endpoints (which locates), so an agent can tell them apart without opening a schema.

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?

It gives an explicit routing rule: 'Call this before pf_call_endpoint for anything you haven't used yet.' The condition (unknown endpoint) and the alternative (pf_call_endpoint) are both named, leaving nothing to inference.

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