Make a SocialCrawl API Request

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

Annotations already declare read-only, idempotent, non-destructive behavior. The description adds the requirement for a valid SOCIALCRAWLIC_API_KEY and explains that platform, resource, and parameters are validated before the call to avoid wasting credits, which is useful context. No contradiction with 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?

Three sentences with the core purpose front-loaded. Each sentence adds relevant information (data types, platforms, key requirement, validation) with no filler 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 schema and annotations, the description adequately covers purpose, key requirement, validation, and data types. Sibling tools handle discovery of platforms/endpoints, and no output schema exists so return value details are not required. It is sufficiently complete for a general-purpose request tool.

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 provides 100% coverage with descriptions for platform, resource, and params. The description only mentions 'validates platform, resource, and parameters' without adding new syntax, formats, or examples beyond what the schema already provides.

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 makes API requests to any SocialCrawl endpoint and fetches real-time social media data from 21 platforms. This distinguishes it from sibling tools that list platforms or endpoints.

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 by noting it requires an API key and validates inputs to avoid wasting credits, but it does not explicitly contrast with sibling tools like socialcrawl_list_platforms or socialcrawl_get_docs, nor state when to prefer this over them.

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