Skip to main content
Glama
CO2T5ZN
by CO2T5ZN

列出分类下的接口

list_apis

List all APIs in a specified Jushuitan Open Platform category, showing each API's name, route, and docId for quick documentation access.

Instructions

列出某个接口分类下的所有 API(名称、路由、docId)。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoryYes分类名称或分类ID,例如「订单API」或「4」

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the burden of behavioral disclosure. It implies a read-only listing operation but does not explicitly state non-mutating behavior, error cases, pagination, or limits. For a simple list tool, it is adequate but lacks explicit safety or boundary details.

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 a single, concise sentence that is front-loaded with the core action and resource, and includes the essential returned fields. No wasted words.

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 tool with no output schema and no annotations, the description is nearly complete. It explains the action, the input context, and the output fields. Minor gaps like pagination or invalid-category behavior are not critical for basic usage, but the lack of any explicit read-only note leaves a small gap.

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% – the single parameter 'category' is already fully described in the schema. The description adds no extra parameter semantics beyond what the schema provides, so the baseline of 3 applies.

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 'all APIs under a category', and specifies the returned fields (name, route, docId). This distinguishes it from sibling tools like list_categories or search_apis without ambiguity.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus the alternatives (list_categories, search_apis, get_api_doc). It only states what it does, leaving the agent to infer selection based on the tool name and context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.