codeCompletionElement

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

With no annotations provided, the description bears full responsibility for disclosing behavior. It only states a retrieval action without mentioning side effects, authorization requirements, error handling, or any operational traits. The minimal disclosure is inadequate for safe invocation.

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 sentence, which is concise, but it lacks structure and front-loads only a generic purpose. It does not earn its place with additional useful details, making it minimally acceptable in conciseness.

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 4 required parameters, no output schema, and no annotations, the description is severely incomplete. It provides no information about return values, error conditions, or operational context, failing to meet the agent's needs for complete understanding.

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 0%, meaning no parameter descriptions exist in the schema. The description fails to add any meaning to the four parameters (line, column, source, sourceUrl), leaving their roles entirely unclear. This is a critical gap.

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 'Retrieves code completion element information,' which identifies a verb and resource, but 'code completion element information' is vague and does not differentiate from sibling tools like 'codeCompletion' or 'codeCompletionFull.' It lacks specificity about what a 'code completion element' is, making the purpose only moderately clear.

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?

No guidance is provided on when to use this tool versus its siblings (e.g., codeCompletion, codeCompletionFull). There is no mention of prerequisites, contexts, or exclusions, leaving the agent without decision support for selection.

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