5.0 KiB
name, description, argument-hint, x-personal-mcp
| name | description | argument-hint | x-personal-mcp | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| new-skill | Provide a practical checklist and baseline template for creating a new docs-first MCP skill in this repository. | What skill are you creating, and what problem should it solve? |
|
New Skill Bootstrap
Use this skill to bootstrap a new skill in the docs-first architecture. Try to use the /create-skill where possible to structure the output, but place it alongside the other skills in this repo.
Inputs
- New skill id (lowercase kebab-case)
- One-sentence capability statement (what it does and when to use it)
- Optional list of references to include under
references/
Source of Truth and Required References
- Use this file as the baseline template for new skill authoring.
- Read and follow these docs before implementing a new skill:
Canonical Skill Shape
Create one skill directory under docs/skills/:
docs/
skills/
<skill-id>/
SKILL.md
references/
... (optional markdown files, nested folders allowed)
Rules:
SKILL.mdis required.- All skill-specific supporting docs live under
references/. - Skill directories are ownership boundaries; no cross-skill writes.
skill-idis lowercase kebab-case and should remain stable.
Framing
Phrasing and language in the skills should reflect the intent of providing preferences and reference documentation, rather than being for a migration or transition. When a particular resource is brought in, it should focus the general way something is done.
SKILL.md Frontmatter Contract
SKILL.md frontmatter is authoritative for skill metadata.
Required top-level fields:
namedescriptionx-personal-mcp
Required x-personal-mcp fields:
idversioncapabilities
Optional x-personal-mcp fields:
tagsdepends_onreferences
Canonical frontmatter template:
---
name: <skill-id>
description: <what this skill does and when to use it>
x-personal-mcp:
id: <skill-id>
version: 1.0.0
tags: []
capabilities:
- resource://skills/<skill-id>/document
depends_on: []
# Optional: only for nested references or metadata overrides.
references:
<ref-id>:
path: references/<file>.md
mime_type: text/markdown
title: <optional short title>
---
Reference manifest rules:
ref-idis lowercase kebab-case.pathis skill-relative and must stay underreferences/.- Top-level
references/*.mdfiles are auto-discovered, andref-idis derived from a normalized filename stem. - Nested
references/**markdown files must be declared explicitly. - Reference paths are markdown files.
URI Surface
Canonical resource URIs for a skill:
resource://skills/<skill_id>/documentresource://skills/<skill_id>/references/<ref_id>
Canonical discovery URIs:
resource://catalog/skills_indexresource://catalog/skills/{skill_id}
Compatibility rule:
- Keep URI families unversioned by default.
- For breaking changes, update clients to the canonical replacement URIs directly.
Scope
- Create docs under docs/skills//.
- Define SKILL frontmatter with Anthropic and x-personal-mcp fields.
- Treat top-level
references/*.mdas auto-discovered references withref-idgenerated from filename. - Declare
x-personal-mcp.referencesonly when you need overrides or nestedreferences/**entries. - Validate the docs build and MCP resource reads.
Authoring Checklist
- Create docs/skills//SKILL.md.
- Add docs/skills//references/ files as needed.
- Keep skill id and directory name aligned.
- Keep frontmatter name equal to x-personal-mcp.id.
- Include resource://skills//document in capabilities.
- For each top-level
references/<name>.md, expectresource://skills/<skill-id>/references/<name>(normalized to lowercase kebab-case). - Add explicit
x-personal-mcp.referencesentries only for nested paths or metadata overrides.
Required Outcomes
- Create
docs/skills/<skill-id>/SKILL.mdwith valid frontmatter and a practical skill body. - Create and populate
docs/skills/<skill-id>/references/with any needed markdown references. - Ensure frontmatter follows repository contract, including
x-personal-mcpfields and canonical capabilities. - Keep URI and reference mapping consistent with repository conventions.
- Reconcile all updates with repository implementation and avoid introducing parallel metadata systems.
Validation
- uv run zensical build
- uv run pytest -q
Output Contract
Return:
- Files created or updated
- Validation results
- Follow-up suggestions for improving the skill