Set Connector Status

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

Annotations declare destructiveHint=true and idempotentHint=true, but the description adds substantial context: paused removes the connector from active runtime, active restores consumer groups with Kafka offset semantics (retention, at-least-once), auth requires org-admin, and pausing interrupts ingestion until resumed. This goes well beyond the structured 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?

Well-structured with bold headers and front-loaded purpose. Every sentence earns its place: behavior, auth, and safety each add distinct operational context. No wasted words.

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?

Complete for a mutation tool with destructive annotations: purpose, behavior, auth, and safety are covered. The lack of output schema means return values could be mentioned, but for a status setter this is a minor gap.

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 75% (cluster, connectorId, organization have descriptions). The description explains the enum values for the status parameter—what 'paused' and 'active' do—adding meaning the schema lacks. It also reinforces required parameters via the safety note, though it does not add format/syntax details for the other parameters.

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 (pause/resume) and resource (every destination in one connector). No sibling tool performs the same connector-level status action; cluster pause/resume is clearly distinct by name and description. An agent can select it without opening the schema.

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?

Implies usage through the purpose and safety note, but offers no explicit when-to-use vs alternatives or when-not-to-use. The safety instruction to confirm parameters adds practical guidance but is not a usage condition. No comparison to pause-cluster/resume-cluster or other connector tools.

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