Skip to main content
Glama
yuque
by yuque

yuque_list_notes

Retrieve paginated notes from your Yuque account, filterable by status.

Instructions

List all notes (小记) for the current user with pagination

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNoFilter by status: 0 (normal), 9 (deleted)
pageNoPage number (default: 1)
limitNoNumber of notes per page (default: 20)
Behavior2/5

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

No annotations provided, and the description only says 'list', implying a read operation but lacks detail on default sorting, whether deleted notes are included by default, or any other behavioral traits. The description does not compensate for the absence of annotations.

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?

A single clear sentence with all essential information front-loaded. No redundant words. The description is appropriately sized.

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

Completeness3/5

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

For a list tool with few parameters and no output schema, the description gives enough basic info but lacks details like default ordering, return format, or any behavioral context. It is adequate but not comprehensive.

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%, so all parameters are already described. The description adds clarification of the resource type but adds no new parameter semantics beyond the schema. Baseline 3 is appropriate.

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 action (list), the resource (notes, clarified with Chinese term 小记), and scope (current user) with pagination. It effectively distinguishes from sibling tools that list other resources like books or docs.

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 versus alternatives. It doesn't specify conditions for filtering or when not to use pagination. Siblings like yuque_search are not mentioned.

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/yuque/yuque-mcp-server'

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