wikijs_get_system_info

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

Discloses that sensitive fields (dbHost, configFile, workingDirectory, hostname) are filtered out. This adds value beyond the schema. No side effects or authentication needs are mentioned, but for a read-only tool this is adequate.

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?

Two sentences, efficient and front-loaded. Every sentence provides clear 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?

Covers what the tool retrieves and what is filtered. Could mention if authentication is required, but without output schema, it is mostly complete for a simple tool.

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?

No parameters exist, so description does not need to add param detail. Baseline of 4 is appropriate.

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?

Clearly states it retrieves system information including specific fields like version, database type, and usage statistics. Distinguishes itself from sibling tools, which are focused on pages, comments, tags, and other entities.

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?

Mentions 'useful for diagnostics' but lacks explicit guidance on when to use or when not to use this tool. However, among siblings, it is the only one for system info, so the context is implied.

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