IvedaAI: Sse

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

The description discloses useful response behaviors: 'status' is the HTTP status code, and 'truncated'/'timedOut' flags indicate cut-off responses. This adds value beyond the readOnlyHint/destructiveHint annotations. It does not discuss authentication or rate limits, but the read-only nature is clear from 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?

The description is compact and front-loaded with the response format caveat. Each line serves a purpose: the general SSE context, the response JSON explanation, and the endpoint-specific query details. It avoids filler, though the formatting could be slightly cleaner for an API reference.

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?

With no output schema, the description provides some return-value context (status, truncated/timedOut) but omits details about event payload structure or how a streaming response is delivered. For a single-endpoint SSE tool, it covers the essentials but leaves the agent to infer real-time streaming semantics and event data shape.

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 description explicitly documents the query parameters 'filter' (with enum values) and 'streamCameraIds' with types, which the schema's generic 'query' object does not specify. This adds essential meaning beyond the structured schema. The operation parameter is also clarified as the endpoint path.

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 identifies a specific operation: GET /api/system/events for server-sent events. It states the resource and HTTP method. However, the opening 'Sse operations' is a category rather than a definitive verb+resource, and it does not explicitly distinguish this from sibling tools like ivedaai_event or ivedaai_streaming.

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?

There is no explicit guidance on when to use this tool versus alternatives. It implies usage for streaming system events but does not state prerequisites, exclusions, or mention that sibling tools like ivedaai_event handle discrete events. The description lacks 'use when' or 'instead of' language.

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