Skip to main content
Glama
powercess

yimu-mcp

by powercess

sync_start

sync_start

Start a rate-limiting sync session before performing batch write operations. Use the returned session ID with sync_end to release the session and avoid throttling.

Instructions

开始同步限流会话(免鉴权,POST /bookkeeping/rateLimit/sync/start)。批量写操作前先 start,全部完成后务必 sync_end 归还会话,避免触发限流。返回 {syncCount, sessionId}。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A4.4/5.0
Behavior3/5

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

No annotations are provided, so the description must carry the full burden. It discloses that the endpoint is免鉴权 (no authentication required), which is useful, and that the tool must be paired with sync_end to avoid triggering rate limits. However, it doesn't describe the lifecycle in detail (what happens if sync_end is never called) or the exact side effects beyond returning a sessionId. This is adequate but not rich.

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 compact and front-loaded: it leads with the primary action and endpoint, then critical usage guidance, then a brief return hint. Every sentence contributes value, with no fluff. The structure is optimal for a no-param tool.

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?

Given the tool has no parameters and no output schema, the description covers the essential context: endpoint, auth requirement, usage sequence, and return shape. The only minor gap is that it could mention error conditions or what happens if sync_start is called again without sync_end, but for an agent the core information is present.

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?

With zero parameters in the schema stub (full coverage implicitly, as there are no params to document), the description correctly focuses on the tool's behavior and output. It mentions the return payload contains {syncCount, sessionId}, which is a form of parameter/return clarification beyond the schema. Since there are no parameters, the baseline for parameter semantics is high (4).

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 tool's purpose in Chinese: '开始同步限流会话' (start sync rate-limit session), specifies the exact endpoint (POST /bookkeeping/rateLimit/sync/start), and positions it as a prerequisite for batch write operations. This distinguishes it from the sibling 'sync_end' which is the matching teardown call.

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

Usage Guidelines5/5

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

The description provides explicit usage guidance: it names the exact scenario (batch write operations), instructs to call this tool before batch writes, and mandates calling 'sync_end' afterward to release the session and avoid rate limiting. It could name a specific alternative, but the pairing with 'sync_end' acts as an implicit alternative and the when-to-use is clear.

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