Get TweetAPI Docs Page

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint, covering the safety profile. The description adds the source file but does not disclose behavior like what happens if the path/keyword is not found or whether the returned content is raw text. It is consistent with annotations but adds limited context beyond them.

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, clear sentence that gets straight to the point. It contains no unnecessary words or repetition, and each word adds value.

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?

The tool is simple with one parameter and strong annotations, but the description fails to explain the parameter semantics, which is essential for correct invocation. It also doesn't describe the output format beyond 'full endpoint documentation section', but given no output schema, a bit more detail would help. Overall, it is minimally adequate but has gaps.

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 schema has a single required parameter pathOrKeyword with no description (0% coverage). The description does not explain what pathOrKeyword accepts (e.g., a file path or keyword), leaving the agent to guess. With zero schema coverage, this is a significant 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 a clear action ('Return') and a specific resource ('full endpoint documentation section') from a named source ('ai-docs-v2.txt'). This distinguishes it from sibling tools like tweetapi_docs_search and tweetapi_endpoint_lookup, which serve different purposes.

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 no guidance on when to use this tool versus alternatives such as tweetapi_docs_search or tweetapi_endpoint_lookup. It doesn't mention any context or exclusions, leaving the agent without direction on selecting this tool.

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