Skip to main content
Glama

file_reservation_paths

Reserve repository-relative paths or globs so other agents know what you are editing. Returns {granted, conflicts}; grants include reservation ids and expiry times, while conflicts name the requested path and its holders.

Instructions

Reserve repository-relative paths or globs so other agents know what you are editing. Returns {granted, conflicts}; grants include reservation ids and expiry times, while conflicts name the requested path and its holders. Conflicts do not fail the call, and nothing blocks the edit itself; the optional git guard refuses commits touching another agent's exclusive reservation. Reserving a path you already hold updates it. Extend with renew_file_reservations and release with release_file_reservations when done.

Input Schema

NameRequiredDescriptionDefault
pathsYesRepository-relative paths or globs.
reasonNoShown to agents whose reservation conflicts.
exclusiveNoDefault true. Shared reservations conflict only with exclusive ones.
agent_nameYesYour registered agent name.
project_keyYesAbsolute path of the repository's primary checkout.
ttl_secondsNoSeconds, default 3600, at most 2592000 (30 days).
idempotency_keyNoNonempty key for this tool and agent. Identical arguments replay with idempotent_replay:true; different arguments fail with IDEMPOTENCY_KEY_CONFLICT. Cleanup runs at server startup and hourly, removing keys older than 7 days. Retries can replay until removal; afterward a retry may perform the operation again.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.1
    • changedInput schema / properties / idempotency_key / description
      Previous value: -"Nonempty key for this tool and agent. Identical arguments replay with idempotent_replay:true; different arguments fail with IDEMPOTENCY_KEY_CONFLICT. Hourly cleanup removes keys older than 7 days. Retries can replay until removal; afterward a retry may perform the operation again."New value: +"Nonempty key for this tool and agent. Identical arguments replay with idempotent_replay:true; different arguments fail with IDEMPOTENCY_KEY_CONFLICT. Cleanup runs at server startup and hourly, removing keys older than 7 days. Retries can replay until removal; afterward a retry may perform the operation again."
  2. Changed1 schema field changedv0.2.5
    • changedInput schema / properties / idempotency_key / description
      Previous value: -"Any string. A retry with the same key and arguments returns the first result."New value: +"Nonempty key for this tool and agent. Identical arguments replay with idempotent_replay:true; different arguments fail with IDEMPOTENCY_KEY_CONFLICT. Hourly cleanup removes keys older than 7 days. Retries can replay until removal; afterward a retry may perform the operation again."
  3. Changed4 schema fields changedv0.2.2
    • changedInput schema / properties / exclusive / description
      Previous value: -"Default true."New value: +"Default true. Shared reservations conflict only with exclusive ones."
    • addedInput schema / properties / idempotency_key / description
      Added value: +"Any string. A retry with the same key and arguments returns the first result."
    • addedInput schema / properties / paths / description
      Added value: +"Repository-relative paths or globs."
    • addedInput schema / properties / reason / description
      Added value: +"Shown to agents whose reservation conflicts."
  4. First observedv0.2.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only provide coarse hints (readOnlyHint false, destructiveHint false); the description adds substantial behavior beyond them: the exact return shape {granted, conflicts}, that conflicts do NOT fail the call, that nothing blocks the edit itself, the git-guard behavior for commits, that re-reserving an already-held path updates it, and the expiry model. This is rich, non-obvious disclosure.

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?

Front-loads the core purpose in the first sentence, then layers return shape, conflict behavior, and lifecycle routing. Dense and largely waste-free, though the git-guard sentence is somewhat tangential to selection and could be trimmed.

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

Completeness5/5

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

With no output schema, the description compensates by spelling out the return object ({granted, conflicts} and their contents) and the non-failing conflict semantics. Combined with the fully documented schema, an agent has everything needed to call and interpret the result.

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 the schema already documents all seven parameters, setting the baseline at 3. The description adds only marginal parameter-level meaning (re-reserving updates an existing hold) and does not clarify semantics like ttl_seconds or idempotency_key beyond what the schema states.

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?

States a specific verb (Reserve) and resource (repository-relative paths or globs) plus the intent ('so other agents know what you are editing'). It is clearly distinguishable from the sibling renew_file_reservations and release_file_reservations, which the description explicitly names.

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

Usage Guidelines4/5

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

Names the lifecycle alternatives explicitly ('Extend with renew_file_reservations and release with release_file_reservations when done'), giving clear context for related actions. It does not state when not to reserve, so it stops short of full 5-level guidance, but routing to siblings is unambiguous.

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