ingest_ticket_logs

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

With no annotations provided, the description carries the full burden. It discloses the full processing pipeline (parse, chunk, embed, store), mentions token-budgeting behavior for Claude models, and notes that it returns ingestion stats. This is transparent about the action and side-effects (storing) without overpromising.

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 two sentences: the first summarizes the core operation; the second provides input details and output. It is front-loaded with the purpose and contains no filler. Every sentence 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?

For a multi-step ingestion tool with no output schema or annotations, the description covers the necessary context: input source, processing behavior, and output type (stats). It does not detail return format or error cases, but those are not critical for tool selection, and the missing details are compensated by the clear pipeline description.

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 coverage is 0%, so the description must compensate. It explains that 'ticket_id' is used to locate the default directory and that 'paths' is an optional explicit list override. This adds meaning beyond the raw schema and clarifies the role of each parameter.

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 action: 'Parse, semantically chunk, embed, and store all log files for a ticket.' It names the specific resource (log files) and the ticket scope. It also distinguishes from siblings by mentioning storage/ingestion, whereas siblings are query/delete operations.

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 explains that it reads raw files from a default Jira MCP download location or an explicit 'paths' list, giving clear context on when to use it (after downloading logs). It does not explicitly state when not to use it or name alternatives, but the purpose is unambiguous and the context is sufficient.

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