Skip to main content
Glama
io.github.akfamily/aktools

io.github.akfamily/aktools

Official
by akfamily

describe_interface

Read-onlyIdempotent

Inspect an AKShare interface to review its title, data source, access restrictions, parameter defaults and types, return columns, alternatives, and call examples before retrieving financial data.

Instructions

查看接口的标题、数据来源与访问限制、其他来源的同类接口(alternatives)、各参数的默认值、类型和说明,以及返回列、数据范围说明与调用示例

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

Input Schema

NameRequiredDescriptionDefault
nameYes接口名,如 stock_zh_a_hist_em

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.8
    • changedInput schema / properties / name / description
      Previous value: -"接口名,如 stock_zh_a_hist"New value: +"接口名,如 stock_zh_a_hist_em"
  2. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds that the response includes cross-source alternatives and data-range caveats, which is genuinely useful, but it does not say what happens when the name is unknown or invalid, nor whether the lookup is exact-match only.

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 a single dense sentence with no filler, and the core action ('view the interface's title...') is front-loaded. The long comma-separated enumeration of returned fields makes it slightly run-on, but every clause carries information.

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 metadata lookup with full schema coverage and an output schema (so return values need no prose), this is close to complete. The missing pieces are minor: error behavior for unknown interface names and a pointer to search_interfaces for name discovery.

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 description coverage is 100% and the schema already gives the 'name' semantics with an example (stock_zh_a_hist_em). The description's mention of 'parameter defaults, types and descriptions' refers to the described interface's parameters, not this tool's single argument, so it adds no meaning about the input itself.

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 (view/describe) applied to a specific resource (an interface/API endpoint) and enumerates exactly what metadata comes back: title, data source and access restrictions, alternatives, parameter defaults/types/descriptions, return columns, data range, and call examples. That enumeration clearly separates it from get_data and search_interfaces, though no sibling is named 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?

There is no explicit when-to-use statement, no mention of calling this before get_data, and no routing to search_interfaces when the exact interface name is unknown. Usage is only implied by the content of what is returned, so an agent must infer the intended workflow.

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