velog_sync_local_index
Sync all public posts for one Velog username into the local keyword index.
Instructions
Sync all public posts for one Velog username into the local keyword index.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Sync all public posts for one Velog username into the local keyword index.
Sync all public posts for one Velog username into the local keyword index.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Changes observed during successful MCP inspections.
v0.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries the full burden. It does disclose meaningful behavior — scope is 'all public posts' and the effect is a write into the local keyword index — but it says nothing about rate limits, network dependence, whether the index is replaced or merged, or error handling.
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 sentence that front-loads the action and scope with zero filler. Nothing could be removed without losing information.
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 one-parameter tool with no annotations and no output schema, the description is minimally viable but leaves gaps: what the tool returns (count of indexed posts?), whether re-syncing duplicates or overwrites entries, and how failures surface are all unstated.
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?
With one required parameter at 0% schema description coverage, the description must compensate. It clarifies the parameter is a single Velog username, but gives no format guidance (e.g. '@' prefix, casing, URL slug vs handle) beyond the schema's length bounds.
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?
States a specific verb (sync) and resource (all public posts for one Velog username) plus the destination (local keyword index), which separates it from read-only siblings like velog_list_posts and velog_search_posts. It does not explicitly contrast with velog_export_local_posts, so it stops short of full sibling differentiation.
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 can infer this is the tool to run before velog_search_local_index, but the description never says so, nor does it state prerequisites or that only public posts are eligible. No exclusions or alternatives are named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.