Skip to main content
Glama

jekyll_docs_create

Generate Jekyll component docs with Overview, Usage, Parameters, Variants, Examples, Accessibility, and Notes; preview changes with dry_run before writing project files.

Instructions

Create component documentation (Overview, Usage, Parameters, Variants, Example, Accessibility, Notes). Modifies project files. Supports dry_run.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesComponent name
dry_runNo
overviewNo
variantsNo
parametersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden; it usefully discloses 'Modifies project files' and that dry_run exists, which an agent needs to know before calling. However, it omits whether existing docs are overwritten, where files land, or what permissions are required.

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?

Three terse sentences, front-loaded with the core action and sections, then the mutation side effect, then the dry_run option. No filler.

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?

For a 5-parameter mutation tool with no annotations, no output schema, and 20% schema coverage, the description covers the essentials (what is created, that files change, dry_run) but leaves dry_run semantics and overwrite behavior unexplained.

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 only 20% (only 'name' is documented), so the description must compensate. It names the documentation sections that map loosely to overview/variants/parameters, but says nothing about the 'name' or 'dry_run' parameters' expected values, leaving real gaps.

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

Purpose4/5

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

States a specific verb+resource ('Create component documentation') and enumerates the exact sections produced, which is far more informative than the bare name. It does not explicitly distinguish itself from the sibling jekyll_docs_update, though the create/update split is inferable from the names.

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?

No guidance on when to use this versus jekyll_docs_update or jekyll_component_create, and no prerequisites stated. 'Supports dry_run' hints at a preview workflow but never says when to prefer it.

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