Export a LogSource definition in REST API format for reuse with create or update tools, enabling backup, migration, or editing of log source configurations.
Export a LogSource definition (REST API format). Output can be used with create_logsource or update_logsource.
| Name | Required | Description | Default |
|---|---|---|---|
| logsource_id | Yes | LogSource ID |
Changes observed during successful MCP inspections.
v4.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnlyHint, idempotentHint, and destructiveHint. The description adds that output is in REST API format and intended for reuse with create/update, which provides meaningful context beyond 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?
One concise sentence with zero waste, front-loading the action and its purpose. Efficient and clear.
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?
Complete for a single-parameter tool with no output schema and annotations covering safety. The description explains the output format and intended use, leaving no gaps for correct invocation.
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 100%, so logsource_id is fully documented in the schema. The description adds no extra parameter semantics, so baseline 3 applies.
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?
States a specific verb (Export), resource (LogSource definition), and format (REST API). Distinguishes from other export_* tools by specifying LogSource, and mentions the output's reuse with create/update tools.
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?
Implies when to use (to export a LogSource definition) and notes the output's compatibility with create_logsource/update_logsource, which gives context. Does not explicitly state when-not or name alternatives, but the intent is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.