opensolr_add_documents

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

With no annotations, the description carries full behavioral disclosure. It reveals the async nature, server-side derived fields, ~1-minute visibility delay, wait semantics, metadata prefixing, URI-based identity with md5(uri), and that job info and Solr ids are returned. This is rich, honest context far beyond the schema.

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 lean sentences front-load the core action and then pack high-value behavioral details without fluff. Every sentence earns its place, covering asynchronous execution, identity, metadata mapping, and return 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?

For a moderately complex ingestion tool with no annotations and low schema detail, the description is unusually complete: async behavior, wait semantics, metadata transformation, identity strategy, and return values are all covered. The remaining gaps are minor-ish: the optional 'ids' parameter and prerequisites like the index needing to exist beforehand.

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%, so the description must compensate for all 5 parameters. It adds real meaning for wait (default true, blocks), metadatas (prefix meta_* fields), and uri (identity/Solr id). However, it leaves 'ids' unexplained and does not explicitly tie 'texts' and 'index' to their expected formats.

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 specific verb and resource: 'Index plain-text documents via the Opensolr Data Ingestion API.' It clearly identifies the operation and distinguishes it from siblings like search, list, delete, and ingest status by action and purpose.

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 usage context is implied by the operation ('Index...documents') and the detailed wait/async behavior, but it never explicitly states when to choose this over alternatives. It also fails to mention prerequisites such as an existing index or the option of using opensolr_ingest_status to poll progress when wait=false.

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