fastly_set_config

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

With no annotations, the description carries full burden. It discloses that the operation is mutating and that it rejects tokens/secrets, and mentions an admin key requirement. However, it does not describe side effects (e.g., overwriting existing values), idempotency, or response/returns, leaving important behavioral gaps.

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?

One concise sentence that leads with the operation type and purpose, with no excess words. Every phrase carries meaning.

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?

Six parameters, no output schema, and no annotations demand a richer description. The current description does not specify required vs optional interplay (e.g., do userId and accountId need to be mutually exclusive?), the format of 'value', the authorization key purpose, or what the response indicates on success/failure. This leaves significant ambiguity for an agent.

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 coverage is 0%, so the description must compensate. It adds context that the configuration is non-secret and scoped to tenant/user or tenant/account, implying the role of userId and accountId, but it does not explain the 'key', 'value', or 'authorizationKey' parameters. The meaning of 'value' is particularly vague.

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 states the verb 'persist' with resource 'configuration' and scope 'tenant/user or tenant/account', and explicitly labels the operation as 'Mutating', distinguishing it from the read-only sibling fastly_get_config. It also notes it rejects secrets, adding precision to its purpose.

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?

The description implies usage for writing configuration but does not explicitly compare with alternatives like fastly_get_config. It provides a condition ('requires the admin key when configured') and a constraint ('reject tokens and secrets'), but no explicit when-to-use vs not-use guidance, so the agent must infer from the tool name.

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