Skip to main content
Glama

看接口说明 / Describe an endpoint

describe
Read-only

看一个接口的参数、返回对象和价格。免费。Parameters, returned object and price of one endpoint. Free.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "endpoint": "<endpoint>"
    },
    "name": "describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
endpointYes接口 ID,例如 douyin.videos.comments.list

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds that the call is free and that the result contains three concrete things (parameters, returned object, price). With no output schema, disclosing the return payload is genuinely valuable beyond structured data. It does not mention rate limits or whether unknown endpoint IDs error, which keeps it below 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is genuinely short and front-loads what the tool returns. The cost is that the Chinese and English sentences say exactly the same thing, so roughly half the text is duplication. That is wasteful but small in absolute terms and may be deliberate for a bilingual audience.

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?

For a one-parameter read-only lookup with no output schema, the definition covers what it returns, that it costs nothing, and the resource granularity. Nothing essential to correct invocation is missing. A hint about error behavior for unknown endpoint IDs would make it complete.

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?

Schema coverage is 100% and the single 'endpoint' property already carries a description plus a concrete example (douyin.videos.comments.list). The description adds no syntax, format, or validation meaning beyond that. Baseline 3 applies when the schema does all the work.

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?

The description names a specific verb-and-resource pair: inspect one endpoint (interface) and return its parameters, its returned object, and its price. That is much more specific than a tautology, and the singular 'one endpoint' contrasts implicitly with the plural/lookup flavor of siblings like find. It stops short of naming an alternative tool, so a single share of differentiation is missing.

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?

The word 'Free' implies the intended workflow of inspecting an endpoint before spending money on it, which is real usage context. However, it never states when to prefer this over find or call, nor any prerequisite such as obtaining a valid endpoint ID first. Usage is implied rather than prescribed.

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