Подключиться к BPMSoft

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

The description adds value beyond annotations. It reveals that the tool validates credentials and that it is a prerequisite for other tools. Annotations already indicate idempotentHint=true and readOnlyHint=false, which are consistent. The behavioral context of 'проверяет учётные данные' (checks credentials) is a key disclosure not present in 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?

The description is two sentences, front-loaded with the primary action and key constraints. Every word is necessary; no repetition or fluff. It efficiently conveys purpose, prerequisites, and effect.

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 complexity (5 parameters, critical prerequisite role) and the absence of output schema, the description covers all necessary aspects: what it does, when to call it, and its impact on sibling tools. It is self-contained and sufficient for an AI agent to understand its role in the overall workflow.

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 100%; all parameters have descriptions. The description lists the parameters (URL, login, password, OData version, platform) and adds that they are validated. It also implies defaults for odata_version and platform. This adds meaning beyond the schema by emphasizing credential checking.

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 that the tool initializes a connection to BPMSoft with parameters (URL, login, password, OData version, platform) and verifies credentials. It explicitly says it must be called first, distinguishing it from sibling tools that require an active connection.

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 provides explicit guidance: it must be called first if the server is not started with environment variables BPMSOFT_URL/USERNAME/PASSWORD. It also notes that after successful call, all other tools become functional. However, it does not mention cases where env vars are present and the tool should be skipped.

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