Keyword gap analysis

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

The description includes '[risk: read-only]' and explicitly states 'No network calls to LinkedIn,' which clearly indicates the tool is safe and has no side effects. Since no annotations are provided, these statements effectively compensate. However, it does not mention any potential constraints like data volume limits or prerequisites.

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 very concise: two sentences plus a bracketed risk tag. Every sentence adds value, and the risk indicator is front-loaded. No unnecessary words or redundancy.

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 lack of output schema, the description adequately outlines what the tool does and roughly what it returns. It covers the core functionality and safety. However, it does not specify the format or structure of the recommendations (e.g., list of keywords with scores), which would be helpful for full completeness.

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?

The description adds significant meaning beyond the schema by linking the two parameters: it explains that jobDescriptions can be used directly, or targetRole serves as a keyword bank. It also hints at the output (missing keywords + natural placement). With 0% schema description coverage, this is essential context. However, it could elaborate on default behavior when jobDescriptions is empty.

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 it reads/analyzes locally stored profile data and compares against job descriptions to recommend missing keywords. The verb 'compare' and 'recommend' specify the action, and it distinguishes from siblings like audit_profile or rewrite_about_section by focusing on keyword gaps. However, the purpose could be more explicit about the output being a list of keywords with placement suggestions.

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 usage when a user wants to identify missing keywords for a target role. However, it does not explicitly state when not to use it, nor does it mention alternatives among siblings (e.g., audit_profile for a different type of analysis). Guidance is implicit but not comprehensive.

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