Search Arma Reforger Workspace

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

Annotations already declare readOnlyHint=true and openWorldHint=false. The description adds context about the types of files searched (text, scripts, configs, etc.), but does not disclose other behaviors such as performance, result limits, or scanning scope. With annotations present, the description provides marginal added value.

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 concise, with a single English sentence and a German translation. It front-loads the purpose without extraneous information. Every word earns its place.

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?

Given the tool has five parameters, no output schema, and 0% schema coverage, the description is highly incomplete. It fails to explain parameter behavior, return format, or effective querying strategies. For a search tool, more context is necessary.

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 description coverage is 0%, so the description must compensate. However, it only lists file types and does not explain any of the five parameters (limit, query, project, extensions, caseSensitive). The description adds little meaning beyond what the schema provides.

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 tool's purpose: searching text, scripts, configs, metadata, prefabs, and world files using a safe literal query. The name 'search_workspace' aligns with the resources searched, and it distinguishes from siblings like search_official_docs and search_local_api.

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 implies usage for workspace search via 'safe literal query' but does not explicitly state when to use this tool over alternatives like search_official_docs or search_local_api. No exclusions or prerequisites are provided.

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