Skip to main content
Glama

velog_format_markdown

Audit Velog Markdown for structure, accessibility, and secret-like content before saving to catch formatting issues and exposed secrets.

Instructions

Audit Velog Markdown for structure, accessibility, and secret-like content before saving.

Input Schema

NameRequiredDescriptionDefault
bodyYes
tagsNo
titleYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

C2.4/5.0
Behavior2/5

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

With no annotations, the description carries the full burden. 'Audit' implies a read-only check, but it never states whether the body is modified, whether findings block a save, what severity levels exist, or what the response looks like. For a validation tool invoked before a write, the absence of any statement about mutability or output is a real gap.

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?

A single front-loaded sentence with no filler, and the three audit dimensions are enumerated compactly. It is efficient, though the brevity is part of why other dimensions are underspecified.

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

Completeness2/5

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

No annotations, no output schema, and 0% parameter documentation. The description should therefore explain what an audit returns and whether it alters input, and it does neither. An agent cannot tell what to do with the result or how it relates to the create/publish siblings.

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

Parameters2/5

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

Schema description coverage is 0% for three parameters, and the description mentions none of them. 'Velog Markdown' loosely implies the body is the audited content, but title, tags, and their constraints (max lengths, tag limits) get no semantic treatment anywhere. The description does not compensate for the coverage gap.

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

Purpose3/5

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

The description gives a specific verb ('Audit') and resource ('Velog Markdown') plus the three check categories (structure, accessibility, secret-like content). However, it conflicts with the tool name 'velog_format_markdown', which suggests reformatting rather than auditing — an agent reading the name may expect the content to be rewritten. That tension leaves the core purpose only partially resolved.

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

Usage Guidelines2/5

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

'before saving' hints at a workflow position but names no alternative. Siblings like velog_create_draft and velog_publish_post are obvious candidates for a 'run this first, then call X' instruction, and none are referenced. No when-not conditions are given either.

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