Users: Create a User

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and idempotentHint=false, so the write semantics are covered. The description adds genuinely useful context beyond that: the required auth header (`api-access-token`) and the locale/digit-handling behavior for Persian/Arabic-Indic input, which are not in the annotations.

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?

Front-loaded with the action and endpoint, then auth and body fields, in a compact block. The locale/digit sentence is slightly tangential but earns its place by warning about input encoding. No redundant sentences.

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?

For a 5-parameter create tool with nested objects and no output schema, the description covers the endpoint, auth, body fields, and input-encoding caveats. It omits error/conflict behavior, but the core information an agent needs to invoke it correctly is present.

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?

Schema description coverage is 100%, so the schema already documents name, email, password, extra_body, and custom_attributes. The description restates the same body fields (name, email, password, custom_attributes) and mentions extra_body, adding no format or constraint detail beyond what the schema provides. Baseline 3 applies.

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?

States a specific verb and resource ('Create a User') plus the concrete endpoint POST /platform/api/v1/users. It does not, however, differentiate this platform-level user creation from the sibling gapify_platform_create_account_user, which an agent could easily confuse it with.

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?

Provides the auth mechanism and endpoint, but gives no guidance on when to use this over the many other creation siblings (create_account, create_account_user, create_agent_bot). No prerequisites, exclusions, or alternative routing are stated.

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