Skip to main content
Glama
jiaweizhang1995

jq-docs-mcp

list_functions

Discover all available JoinQuant API functions, grouped by section. Use this to explore what functions exist before searching for specific documentation.

Instructions

List all available JoinQuant API function names, grouped by section. 列出所有可用的聚宽API函数名,按文档分类分组。

Use this to discover what functions are available before looking up specific ones.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It states the core behavior (list names, grouped by section) but omits any note about read-only nature, potential result size, or output structure. For a simple list operation this is adequate but not extra informative.

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 concise sentences in English and Chinese, plus a clear usage note. No extraneous information. Front-loaded with the primary purpose.

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?

Tool is simple (no params), and output schema exists, so description doesn't need to explain return values. It covers the main function and usage purpose. Could mention if it returns descriptions or just names, but for discovery it's sufficiently complete.

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

Parameters4/5

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

Input schema is empty with zero parameters, so baseline is 4. Description adds nothing about parameters (none exist), but this is fine since the schema trivially covers everything and no parameter semantics are needed.

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?

Description clearly states it lists all available JoinQuant API function names, grouped by section. This is a specific verb+resource and differentiates from siblings like list_by_section (which lists a specific section) and lookup_function (which finds details).

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

Usage Guidelines4/5

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

Provides explicit usage context: 'Use this to discover what functions are available before looking up specific ones.' This indicates when to use (for initial discovery) and implicitly contrasts with looking up specific functions. No formal alternatives named, but the guidance is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jiaweizhang1995/jq-docs-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server