Skip to main content
Glama
Sign In
@kedoupi/yapi-mcp

@kedoupi/yapi-mcp

by kedoupi
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

yapi_get_interface

Retrieve detailed information about a specific API interface by its ID, including its schema, parameters, and response details.

Instructions

Get detailed information about a specific API interface

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": {
      "interface_id": "<interface_id>"
    },
    "name": "yapi_get_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
interface_idYesInterface ID to retrieve

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description must disclose behavioral traits. It does not mention that the operation is read-only, what 'detailed information' includes, or any prerequisites or failure modes. The description adds no behavioral context beyond the basic action.

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 with no redundant words. It is appropriately short for the tool's simplicity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has no annotations, no output schema, and a minimal description. It does not clarify the nature of the returned data, usage context, or relationship to sibling tools. For a single-parameter get operation, some explanation of expected output or use cases is needed.

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 covers 100% of the parameter description, so the baseline is 3. The description reiterates 'specific API interface' but adds no additional meaning about the interface_id parameter or its usage.

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 states a clear verb ('Get') and resource ('API interface'), indicating it retrieves details for a specific interface. While it doesn't explicitly differentiate from siblings like yapi_get_interface_menu, the purpose is unambiguous.

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?

No guidance on when to use this tool vs alternatives such as yapi_search_interfaces or yapi_get_interface_menu. The description only provides a generic statement with no context or exclusions.

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

Deploy Server

Other Tools