cst_read_project_log

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

With no annotations provided, the description bears the full burden of behavioral disclosure. It states that the tool returns solver running state and log file contents, but does not address edge cases, authentication requirements, or potential side effects. Given it is a read-only operation, the description is adequate but lacks depth.

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, consisting of two clear sentences that provide essential information without redundancy. Every sentence adds value: the first defines the action, the second explains utility.

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 simple read tool with no parameters and no output schema, the description fully covers what the tool does, what it returns, and its typical use cases. It mentions both the running state and log file contents, which is sufficient for an agent to understand the tool's functionality.

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 input schema has zero parameters, so there is no parameter information to add beyond what the schema provides. According to guidelines, this merits a baseline score of 4, and the description appropriately does not attempt to describe nonexistent parameters.

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 reads solver log files and project status information from the current CST project, specifying it returns solver running state and the most recent log file contents. This distinctively differentiates it from sibling tools like cst_get_solver_info or cst_get_simulation_status, which may return different data.

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 suggests it is useful for diagnosing solver errors and checking simulation progress, implying when to use it. However, it does not provide explicit guidance on when not to use it or contrast it with similar tools such as cst_get_solver_info or cst_get_result_summary.

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