Skip to main content
Glama
DouglasGBailey

teaching-mcp-server

Write a workspace file

write_file

Create or overwrite a text file in the sandboxed workspace directory, automatically creating any missing parent directories.

Instructions

Create or overwrite a text file inside the server's sandboxed 'workspace' directory. Parent directories are created automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the file, relative to the workspace root.
contentYesThe full text content to write.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/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 does add real behavioral context: writes are confined to a sandboxed workspace directory, and parent directories are auto-created. It discloses the overwrite/destructive nature implicitly via 'overwrite' but says nothing about encoding, error behavior, or path-escape handling.

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 short sentences, zero filler, with the core create/overwrite action front-loaded before the secondary parent-directory detail. Every sentence earns its place.

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 2-parameter write tool with no annotations and no output schema, the description covers purpose, sandbox scope, and the auto-mkdir behavior, which is enough to invoke correctly. It leaves the overwrite consequences and error/return behavior unstated, a minor gap given the low complexity.

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% and both parameters are documented in the schema itself, so the baseline is 3. The description adds no path syntax, relative-path rules, or content format details beyond what the schema already provides.

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?

The description gives a specific verb pair ('create or overwrite') on a specific resource ('a text file') scoped to the 'workspace' directory, so an agent immediately knows this is the write counterpart to read_file. It never names a sibling or contrast case, so it stops short of the top band.

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?

Usage is implied rather than stated: the agent can infer 'write a file' from create/overwrite semantics. There is no explicit when-to-use, when-not-to-use, or pointer to an alternative tool, so the guidance is the minimum viable.

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