Document reference SDK (#3)

* Document reference SDK

* Update docs/integrate-skills.mdx

Co-authored-by: Keith Lazuka <klazuka@anthropic.com>

---------

Co-authored-by: Keith Lazuka <klazuka@anthropic.com>
This commit is contained in:
Eric Harmeling
2025-12-18 10:19:21 -05:00
committed by GitHub
Unverified
parent 547831f3a2
commit f990ba148d
5 changed files with 37 additions and 1 deletions
View File
+8 -1
View File
@@ -73,7 +73,7 @@ The Agent Skills format was originally developed by [Anthropic](https://www.anth
## Get started
<CardGroup cols={2}>
<CardGroup cols={3}>
<Card
title="What are skills?"
icon="lightbulb"
@@ -102,4 +102,11 @@ The Agent Skills format was originally developed by [Anthropic](https://www.anth
>
Browse example skills on GitHub.
</Card>
<Card
title="Reference library"
icon="wrench"
href="https://github.com/agentskills/agentskills/tree/main/skills-ref"
>
Validate skills and generate prompt XML.
</Card>
</CardGroup>
+18
View File
@@ -79,3 +79,21 @@ Script execution introduces security risks. Consider:
- **Allowlisting**: Only execute scripts from trusted skills
- **Confirmation**: Ask users before running potentially dangerous operations
- **Logging**: Record all script executions for auditing
## Reference implementation
The [skills-ref](https://github.com/agentskills/agentskills/tree/main/skills-ref) library provides Python utilities and a CLI for working with skills.
For example:
**Validate a skill directory:**
```
skills-ref validate <path>
```
**Generate `<available_skills>` XML for agent prompts:**
```
skills-ref to-prompt <path>...
```
Use the library source code as a reference implementation.
+10
View File
@@ -216,3 +216,13 @@ scripts/extract.py
```
Keep file references one level deep from `SKILL.md`. Avoid deeply nested reference chains.
## Validation
Use the [skills-ref](https://github.com/agentskills/agentskills/tree/main/skills-ref) reference library to validate your skills:
```bash
skills-ref validate ./my-skill
```
This checks that your `SKILL.md` frontmatter is valid and follows all naming conventions.
+1
View File
@@ -68,3 +68,4 @@ This simple format has some key advantages:
- [Add skills support to your agent](/integrate-skills) to build a compatible client.
- [See example skills](https://github.com/anthropics/skills) on GitHub.
- [Read authoring best practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) for writing effective skills.
- [Use the reference library](https://github.com/agentskills/agentskills/tree/main/skills-ref) to validate skills and generate prompt XML.