Skip to main content
Glama

trw_claude_md_sync

Synchronizes instruction markdown files for persistent engineering memory, maintaining backward compatibility with older callers.

Instructions

Deprecated alias for trw_instructions_sync.

Use when: maintaining backward compatibility with older callers; prefer trw_instructions_sync in new code. This alias emits a deprecation warning on every invocation and will be removed in a future release.

Output: same as trw_instructions_sync — ClaudeMdSyncResultDict with fields {status, files_written, sections_synced}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scopeNoroot
clientNoauto
target_dirNo
Behavior4/5

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

With no annotations, the description carries full burden. It discloses the deprecation warning on every invocation and states output is identical to trw_instructions_sync. Though it doesn't detail the sync operation itself, the alias behavior and output equivalence are sufficiently transparent for a deprecated tool.

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?

Very concise and front-loaded: the first sentence declares deprecation and alias. Every sentence adds value, with no wasted words.

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

Completeness3/5

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

Given the tool is a deprecated alias, the description adequately covers purpose and output equivalence. However, it lacks parameter documentation and no output schema is provided, which is a gap for correct invocation. Completes the immediate context but leaves invocation details underspecified.

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

Parameters1/5

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

Schema description coverage is 0%, but the description does not explain the parameters (scope, client, target_dir) at all. It only mentions output fields. This leaves the agent with no semantic guidance for parameter values beyond the schema.

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 it is a deprecated alias for trw_instructions_sync, with a specific verb ('maintaining backward compatibility') and resource ('alias'). It distinguishes itself from siblings by noting deprecation and redirecting to the preferred tool.

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?

Explicitly specifies when to use (backward compatibility) and when not to ('prefer trw_instructions_sync in new code'). Also mentions deprecation warning and future removal, guiding the agent's decision.

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/wallter/trw-mcp'

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