Switch connection profile

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

The description adds meaningful side-effect context beyond the annotations: it discloses persistence to the env file and clearing of identity-scoped caches (OAuth tokens, schema, plugin availability). This is useful behavioral disclosure even though destructiveHint=false; clearing caches is not presented as destructive to persistent data.

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?

Two tight sentences. The primary action is front-loaded, and the side-effect detail is presented in a compact second sentence with no filler.

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 simple profile-switching tool, the description, paired with parameter schema and annotations, covers the essential behavior, persistence, and cache effects. It does not mention return values or error conditions, but the absence of an output schema and the tool's simple state-changing nature make this 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?

Both schema parameters already have clear descriptions: 'name' indicates the profile to activate and 'instance' explains the per-call override with a pointer to servicenow_list_instances. Since schema coverage is high, the description does not need to add parameter detail, and it does not.

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 states a specific verb ('Switch') and resource ('active ServiceNow connection profile'), and specifies it is persisted to the env file. This clearly differentiates it from sibling tools like servicenow_list_instances or servicenow_set_credentials.

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 the tool is used when you want to change the active ServiceNow profile, but it does not explicitly compare with alternatives or state when not to use it. The schema references servicenow_list_instances for discovering profiles, but the description itself gives no usage guidance beyond the core action.

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