Skip to content

agent-description

Agent description must be at least 10 characters

From plugin
claudelint
1113 skills13 agents1 command1 hook
Install
$ npx -y skills add pdugan20/claudelint --agent claude-code

How it fires

How this agent gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.

Context preview

The summary Claude sees to decide when to auto-load this agent.

Agent description must be at least 10 characters

Agent definition

agent-description.md
description: "Agent description must be at least 10 characters"

agent-description

<RuleHeader description="Agent description must be at least 10 characters" severity="error" :fixable="false" :configurable="false" category="Agents" />

Rule Details

This rule enforces a minimum length on the description field in agent markdown frontmatter. The description must be at least 10 characters. Validation is delegated to the AgentFrontmatterSchema.shape.description Zod schema. Agent descriptions may include XML-style tags like `<example>` and `<commentary>` which are conventional for trigger matching.

Incorrect

Agent description that is too short

---
name: code-review
description: Reviews
---

Correct

Descriptive agent description

---
name: code-review
description: Handles code reviews for pull requests and suggests improvements
---

How To Fix

Write a description of at least 10 characters that clearly explains what the agent does and when it should be triggered.

Options

This rule does not have any configuration options.

Related Rules

  • [`agent-name`](/rules/agents/agent-name)

Resources

  • [Rule Implementation](https://github.com/pdugan20/claudelint/blob/main/src/rules/agents/agent-description.ts)
  • [Rule Tests](https://github.com/pdugan20/claudelint/blob/main/tests/rules/agents/agent-description.test.ts)

Version

Available since: v0.2.0

Read more
Ships withclaudelint

A linter for Claude Code projects. Validates CLAUDE.md files, skills, settings, hooks, MCP servers, plugins, and more.

Get the whole plugin, auto-invoked
Stats
11
Stars
0
Views
0
Forks
Active
Maintenance
TypeScript
Language
MIT
License
2d ago
Last commit
6mo ago
Created

Repo: pdugan20/claudelint