pipeline_create

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a creation operation, implying it's a write/mutation tool, but doesn't mention permissions required, whether it overwrites existing pipelines, error handling beyond the on_failure parameter, or what the response looks like. The example shows syntax but lacks behavioral context like idempotency or side effects.

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 appropriately sized but not optimally structured. It starts with the purpose, then lists parameters, provides an example, and ends with a processor reference list. However, the processor list is quite extensive (11 items) and might be better placed in a separate reference. The content is valuable but could be more front-loaded with critical usage information.

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 4-parameter mutation tool with no annotations and no output schema, the description does a reasonable job. It explains what the tool does, documents parameters, provides an example, and lists processor types. However, it lacks crucial behavioral details like response format, error conditions, permissions, and idempotency behavior that would be needed 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?

With 0% schema description coverage, the description compensates well by listing all 4 parameters with brief explanations (id, description, processors, on_failure) and providing an extensive list of common processor types with their functions. This adds significant semantic value beyond the bare schema, though it doesn't detail parameter formats or constraints beyond the examples.

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 the purpose: '创建 Ingest Pipeline' (Create Ingest Pipeline), which is a specific verb+resource combination. It distinguishes from sibling tools like pipeline_delete and pipeline_get by focusing on creation. However, it doesn't explicitly differentiate from pipeline_simulate or other ingest-related tools beyond the basic action.

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. There are no mentions of prerequisites, when-not-to-use scenarios, or comparisons with sibling tools like pipeline_simulate or other ingest processors. The example and processor list are helpful but don't constitute usage guidelines.

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