Skip to main content
Glama

write_integration_file

Writes or updates a Studio project file, validating XML well-formedness before saving and creating a .bak backup by default to protect existing content.

Instructions

Write or update a file in a Studio project. Validates XML well-formedness before writing. Creates a .bak backup by default.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_name": "<project_name>",
      "file_path": "<file_path>",
      "content": "<content>"
    },
    "name": "write_integration_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYesThe file content to write
file_pathYesPath to the file relative to the project root
project_nameYesThe Studio project name
create_backupNoCreate a .bak backup of the existing file before overwriting. Defaults to the server config setting.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.8.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and adds genuinely useful behavior beyond the schema: XML well-formedness validation before writing, and automatic .bak backup creation. It leaves gaps around overwrite semantics, whether the file must already exist, and how validation failures are surfaced. But the validation and backup disclosures are substantive, non-derivable detail that justify a score above baseline.

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?

Three short sentences with zero waste. The primary purpose is front-loaded, followed by two key behavioral facts the agent cannot get from the schema. Nothing is redundant or padded.

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 4-parameter write tool with no output schema, the description covers the essential purpose, validation behavior, and backup behavior. The remaining gaps are failure modes and permissions. These are minor relative to the core operation, but a complete definition would address what happens on validation failure.

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 description coverage is 100%, so all four parameters—project_name, file_path, content, and create_backup—are already documented in the schema. The description provides no additional parameter meaning, format constraints, or syntax details. With the schema doing the heavy lifting, the baseline of 3 applies.

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

Purpose4/5

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

States a specific verb and resource: 'Write or update a file in a Studio project.' This clearly distinguishes it from read_integration_file, delete_file, and rename_file. Sibling differentiation is implicit through the write verb rather than explicit naming, so it falls just short of a 5.

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?

Provides no explicit when-to-use or when-not-to-use guidance and names no alternatives. The agent must infer that this is the tool for creating or modifying file contents as opposed to reading, copying, or validating. Guidance is implied only by the verb 'Write or update.'

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