From 22d6aeb3534dd657d6adfea30cd8b1aec89eb83d Mon Sep 17 00:00:00 2001 From: Koichi ITO Date: Tue, 10 Mar 2026 01:54:10 +0900 Subject: [PATCH] Fix example description to include "when to use" guidance 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. --- docs/client-implementation/adding-skills-support.mdx | 2 +- docs/specification.mdx | 2 +- docs/what-are-skills.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/client-implementation/adding-skills-support.mdx b/docs/client-implementation/adding-skills-support.mdx index 0a27d0a..6c78430 100644 --- a/docs/client-implementation/adding-skills-support.mdx +++ b/docs/client-implementation/adding-skills-support.mdx @@ -168,7 +168,7 @@ For each discovered skill, include `name`, `description`, and optionally `locati pdf-processing - Extract text and tables from PDF files, fill forms, merge documents. + Extract PDF text, fill forms, merge files. Use when handling PDFs. /home/user/.agents/skills/pdf-processing/SKILL.md diff --git a/docs/specification.mdx b/docs/specification.mdx index 8fe6577..34d3a9a 100644 --- a/docs/specification.mdx +++ b/docs/specification.mdx @@ -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 diff --git a/docs/what-are-skills.mdx b/docs/what-are-skills.mdx index 11c65d7..0f80ba0 100644 --- a/docs/what-are-skills.mdx +++ b/docs/what-are-skills.mdx @@ -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