sync_repo_markdown

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

With no annotations, the description carries the full burden, and it does disclose meaningful behavior: file-selection rules, excluded vendored directories, the exact write destination (wiki/repos/<repo>/repo-docs/), and a side effect (recording sync state in the registry). It omits whether existing docs are overwritten or merged, idempotency/rate-limit behavior, and error handling, which keeps it short of a 5.

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

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

A single front-loaded sentence that leads with the verb and resource, with the detailed path/exclusion lists packed into a parenthetical. Information-dense and mostly earning its place, though the parenthetical is heavy enough to slightly hinder scanning.

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

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

For a mutation tool with no annotations and no output schema, the description covers what is fetched, what is skipped, where output goes, and that registry state is updated. It is fairly complete, with the main remaining gaps being overwrite semantics and repo identifier format.

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

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

Schema coverage is 50%: the token parameter is documented in the schema, but repo is bare. The description only implies that repo identifies a GitHub repository and never specifies the expected format (e.g., owner/name), so it fails to compensate for the coverage gap.

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

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

The description states a specific verb (sync) and resource (repository markdown docs from GitHub) and enumerates exactly what is fetched (.md/.mdx files, README/CLAUDE.md, docs/, specs/, plans/, reports/, architecture/) and where it lands. It is immediately distinguishable from read/search/compile siblings, which operate on the wiki rather than pulling from GitHub.

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

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

Usage is only implied: an agent infers you call this to pull a repo's markdown into the wiki, but there is no explicit when-to-use, no prerequisites (e.g., repo access, prior repo registration), and no mention of alternatives such as search_repo_docs or load_repo_context.

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