Skip to main content
Glama

aanet_append_file

Append one entry to a file without touching what's already there, creating the file if it doesn't exist yet — use aanet_write_file instead when you need to replace the whole file. Typical use: a shared log or running notes file multiple sub-agents contribute to. Fires a file_write webhook event on success. Returns {path, appended, etag}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesVirtual file path within the workspace.
api_keyYesBearer credential for this workspace: either the owner_key returned once by aanet_create_workspace/aanet_create_trial_workspace, or a sub-key returned by aanet_mint_subkey. Sent under the hood as `Authorization: Bearer <api_key>`. Owner-only tools reject a sub-key with a 403.
contentYesText to append as a new entry — the existing content is kept.
if_matchNoThe file's current etag, for the same conflict-detection purpose as on aanet_write_file.
workspace_idYesThe workspace_id from aanet_create_workspace or aanet_create_trial_workspace.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / api_key / description
      Added value: +"Bearer credential for this workspace: either the owner_key returned once by aanet_create_workspace/aanet_create_trial_workspace, or a sub-key returned by aanet_mint_subkey. Sent under the hood as `Authorization: Bearer <api_key>`. Owner-only tools reject a sub-key with a 403."
    • addedInput schema / properties / content / description
      Added value: +"Text to append as a new entry — the existing content is kept."
    • addedInput schema / properties / if_match / description
      Added value: +"The file's current etag, for the same conflict-detection purpose as on aanet_write_file."
    • addedInput schema / properties / path / description
      Added value: +"Virtual file path within the workspace."
    • addedInput schema / properties / workspace_id / description
      Added value: +"The workspace_id from aanet_create_workspace or aanet_create_trial_workspace."
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and discloses key behaviors: append semantics (doesn't touch existing), creation on missing file, a side effect (fires file_write webhook), and the return shape. It could mention authentication requirements or conflict behavior, but the schema covers api_key and if_match. This is solid transparency.

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

Conciseness5/5

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

Two sentences with zero waste: the primary behavior is front-loaded, followed by the alternative, a use case, a side effect, and the return value. Every sentence earns its place and the structure is optimal for quick comprehension.

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?

For a tool with a rich schema and no output schema, the description is nearly complete: it covers behavior, alternatives, side effects, and return shape. It doesn't explicitly state error conditions or auth prerequisites, but the schema covers api_key, and the use case is clear. Nothing critical is missing for correct invocation.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents all five parameters thoroughly. The description adds minimal parameter insight beyond stating 'append as a new entry', which matches the content parameter. Baseline 3 is appropriate since the schema does the heavy lifting.

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 states a specific verb and resource ('Append one entry to a file') with explicit constraints (doesn't touch existing content, creates if missing) and distinguishes itself from aanet_write_file by naming the alternative. This makes the tool's purpose unambiguous and differentiates it from sibling tools.

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

Usage Guidelines5/5

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

The description explicitly tells the agent when to use this tool versus aanet_write_file ('use aanet_write_file instead when you need to replace the whole file') and provides a typical use case (shared log or running notes). This is clear, actionable guidance with an alternative named.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources