CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

generate-doc-description

Call use_skill as your FIRST and ONLY action when the user asks to document, add descriptions to, annotate, or add doc:description attributes to Mule XML files, flows, components, or connectors. Do not read project files first — this skill provides instructions for when to read files. Covers documenting all Mule elements in src/main/mule including flows, sub-flows, configs, listeners, processors, transforms, error handlers, and connectors. When you call use_skill, it must be the only tool call in that response.

61

Quality

77%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./skills/mule-development/generate-doc-description/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

50%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is highly actionable with a complete example template and concrete step sequence, but it is padded with duplicated rule blocks and repeated emphasis, includes no post-write XML validation feedback loop for a batch-modification workflow, and inlines a large example that belongs in a separate reference file. Consolidating redundancy and adding a verification step would raise quality substantially.

Suggestions

Merge the "Rules" and "Important Rules" sections into a single non-redundant rule list, and state the 150-character limit and the Read/Write turn-separation requirement only once each.

Add an explicit post-write validation step (e.g., re-read or parse the written XML to confirm well-formedness and that non-doc content is byte-preserved) with a fix-and-retry loop, which would lift the workflow_clarity cap for this batch XML-modification skill.

Move the ~110-line annotated XML example template and the detailed element taxonomies into a references/ file (e.g., references/example-template.xml and references/element-taxonomy.md) and link to them from SKILL.md, reducing the main body to a lean overview and workflow.

DimensionReasoningScore

Conciseness

The body is noticeably verbose: rules are duplicated between "Rules" and "Important Rules" (e.g., "Do NOT modify, add, or remove any non-doc attributes or elements" and "Preserve ALL existing XML structure..." appear twice), the 150-character limit is stated at least three times, the Read/Write-separation rule is repeated three times, and there are two competing "#### C" sections. Several padded/redundant sections fit anchor 2 rather than the mostly-efficient anchor 3.

2 / 5

Actionability

Guidance is mostly executable: a concrete glob pattern ("src/main/mule/**/*.xml"), exhaustive element taxonomies, an explicit pre-edit analysis output template, and a complete 110-line annotated XML example. It falls short of anchor 5 only through minor gaps such as no concrete command for verifying written XML.

4 / 5

Workflow Clarity

Steps 1-6 are clearly sequenced with checkpoints (read-before-write verification, the explicit component-listing gate, per-file approval), but this batch XML-rewrite workflow lacks any post-write validation or well-formedness feedback loop. Per the rubric's cap for batch/destructive XML operations without validation, workflow clarity cannot exceed 3.

3 / 5

Progressive Disclosure

The skill has reasonable section structure (Overview, Rules, numbered steps) but is a ~300-line monolith with no bundle files: the 110-line XML example template and the long element taxonomies are content that clearly belongs in a separate reference file inlined in SKILL.md. Structure exists but content that should be separate is inline, matching anchor 3.

3 / 5

Total

12

/

20

Passed

Description

92%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: it names concrete capabilities, comprehensively enumerates the Mule element types covered, and provides explicit user-trigger phrasing for both what and when. The only weakness is minor missing natural synonyms such as "MuleSoft" or an explicit ".xml" extension reference.

DimensionReasoningScore

Specificity

The description lists multiple concrete actions ("document, add descriptions to, annotate, or add doc:description attributes to") with comprehensive coverage of targets ("flows, sub-flows, configs, listeners, processors, transforms, error handlers, and connectors"). It matches the anchor for multiple specific concrete actions with comprehensive coverage, not the level below where only minor gaps exist.

5 / 5

Completeness

It explicitly answers both what ("add doc:description attributes to Mule XML files, flows, components, or connectors") and when ("when the user asks to document, add descriptions to, annotate...") with concrete trigger phrases. Both are explicit, matching the top anchor rather than anchor 4 where the 'when' is less specific.

5 / 5

Trigger Term Quality

Natural phrasings like "document", "add descriptions to", "annotate", and "doc:description attributes" give good keyword coverage, but common synonyms such as "MuleSoft" and an explicit ".xml" extension mention are missing. Good coverage with a few natural terms missing fits anchor 4 rather than the comprehensive anchor 5.

4 / 5

Distinctiveness Conflict Risk

The description occupies a clear niche (Mule XML doc:description documentation) with distinct, unambiguous triggers unlikely to fire for other skills. This matches the clear-niche/minimal-conflict anchor, not the mostly-distinct anchor 4.

5 / 5

Total

19

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

mulesoft/mulesoft-dx

Path

skills/mule-development/generate-doc-description/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.