PingCode User Login (OAuth)

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

Discloses that the tool does not read browser cookies/storage, saves user token to a local file with 0600 permissions, and explains the two-step flow. With no annotations provided, the description carries full burden and covers key behaviors.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Description is concise and front-loaded, stating the purpose first then detailing the two scenarios. Every sentence adds value without redundancy.

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

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

Given one optional parameter and no output schema or annotations, the description adequately covers the tool's behavior for both input cases. It could optionally mention the structure of the returned current user object.

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

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

Input schema has 100% coverage for the single 'code' parameter. Description adds meaning by explaining the two modes (with/without code) and what the code represents, going beyond the schema description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the tool is for user-space browser authorization login, using specific verb (login) and resource (PingCode user auth). It distinguishes from siblings like pingcode_auth_status and pingcode_auth_logout by focusing on the login step.

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

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

Description explains two usage modes: without code to get authorization URL, with code to complete login. It also warns not to paste web login token. However, it doesn't explicitly mention when to use alternatives like auth_status.

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