platform_auth_profiles

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

With no annotations, the description carries the full burden. It discloses that raw secrets are not placed in MCP context and that secure secret entry/OAuth consent happens via the Studio flow. It also lists the action verbs, giving a hint of behavior. But it does not describe side effects, return values, or constraints like the confirm flag for destructive actions, which are left to the schema.

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?

The description is a single dense paragraph, which is not ideal for scanning. It front-loads the Arch Build context and then lists actions, but the structure could be improved with bullet points or clearer separation of purpose vs. usage. It is not overly verbose, but not optimally organized.

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 the tool's complexity (23 parameters, 10 actions) and lack of output schema or annotations, the description is incomplete. It does not explain the purpose of each action, when to use each, or what the responses look like. The secure flow is mentioned but not detailed enough for an agent to know exactly how to initiate or complete OAuth. Significant guidance is missing.

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 only 35%, and the description compensates only marginally. It clarifies that `config` rejects raw credentials and that `connectionConfig` is for OAuth URL templates, but it does not explain most of the 23 parameters (e.g., name, tags, scope, usageMode, visibility, environment). With such low schema coverage, the description should cover more parameter semantics to be useful.

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?

The description clearly states the verb and resource: 'Manage project auth profiles'. It enumerates the supported actions and mentions the key constraint of not placing raw secrets in MCP context. However, it does not explicitly distinguish itself from sibling tools like platform_integrations or platform_projects, relying on the 'auth profiles' specificity to separate it.

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 this tool is for managing auth profiles and mentions the secure Studio flow for secret entry, giving some context on when to use it. However, it does not explicitly state when not to use it or compare against alternatives among the many platform_* siblings. The guidance is implied rather than explicit.

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