Skip to main content
Glama
Heretek-RE

re-report-write

by Heretek-RE

write_report

Write Markdown content to a specified file path with integrity verification via SHA-256. Supports conditional overwrite to prevent accidental data loss.

Instructions

Write content to path and return the SHA-256 of the result.

The function is the foundational primitive the re-report skill uses to commit report fragments to Output/<run-id>/<file>.md. The returned SHA-256 is the integrity hash the run manifest records.

Args: path: file to write (must not contain .. or target a system directory) content: text content (typically Markdown) overwrite: if True, overwrite an existing file; if False, refuse to overwrite

Returns::

{
  "path": "...",
  "size": N,
  "sha256": "<64 hex chars>",
  "overwritten": bool,
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
contentYes
overwriteNo
Behavior4/5

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

With no annotations, the description fully discloses the write operation, path constraints, overwrite behavior, and return schema, though it omits authentication or rate limit details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a summary, parameter list, and return schema, but includes some extraneous context about the 're-report' skill that could be more concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 3 parameters with 0% schema coverage and no output schema, the description provides comprehensive details on usage, constraints, and return values, though minor gaps like error handling exist.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, but the description compensates with detailed parameter semantics: path constraints, content type, and overwrite logic, adding value beyond the schema's titles.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's action (write content to path), output (SHA-256), and its role in the 're-report' skill, distinguishing it from siblings like 'check_report_write' and 'write_table'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides implicit context about when to use (for committing report fragments) but lacks explicit when-not or comparisons to sibling tools, leaving the agent to infer usage boundaries.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Heretek-RE/re-report-write'

If you have feedback or need assistance with the MCP directory API, please join our Discord server