agent/agentskills
2
0
Fork 0
mirror of https://github.com/agentskills/agentskills.git synced 2026-06-18 15:54:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix example description to include "when to use" guidance

Browse Source 
The example `description` values in what-are-skills.mdx and
specification.mdx only described what the skill does, but omitted
when to use it. This contradicted the spec's own guidance that
description should cover both. Added a "Use when..." clause while
keeping the line short enough to avoid clipping in the rendered
code block on the docs site.
This commit is contained in:
Koichi ITO
2026-03-10 01:54:10 +09:00
Unverified
parent f2451a722f
commit 22d6aeb353
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/client-implementation/adding-skills-support.mdx
+1 -1
View File
@@ -168,7 +168,7 @@ For each discovered skill, include `name`, `description`, and optionally `locati
<available_skills>
<skill>
<name>pdf-processing</name>
<description>Extract text and tables from PDF files, fill forms, merge documents.</description>
<description>Extract PDF text, fill forms, merge files. Use when handling PDFs.</description>
<location>/home/user/.agents/skills/pdf-processing/SKILL.md</location>
</skill>
<skill>
docs/specification.mdx
+1 -1
View File
@@ -36,7 +36,7 @@ With optional fields:
```yaml
---
name: pdf-processing
description: Extract text and tables from PDF files, fill forms, merge documents.
description: Extract PDF text, fill forms, merge files. Use when handling PDFs.
license: Apache-2.0
metadata:
author: example-org
docs/what-are-skills.mdx
+1 -1
View File
@@ -32,7 +32,7 @@ Every skill starts with a `SKILL.md` file containing YAML frontmatter and Markdo
```mdx
---
name: pdf-processing
description: Extract text and tables from PDF files, fill forms, merge documents.
description: Extract PDF text, fill forms, merge files. Use when handling PDFs.
---
# PDF Processing