Skip to content

docs(TSP-1107): document Skills API structured fields including when_to_use#557

Closed
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1107
Closed

docs(TSP-1107): document Skills API structured fields including when_to_use#557
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1107

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented Mar 26, 2026

Summary

  • Adds a new 'Creating skills programmatically' section to agent-skills.mdx
  • Documents all four structured fields: name, description, when_to_use, and content
  • Explains the distinction between description (what the skill does) and when_to_use (activation hints for AI agents)
  • Covers trusted skills and why when_to_use is particularly important for them
  • Includes a realistic Python code example demonstrating all four fields
  • Promotes Topics covered to a top-level heading since it now sits at the same hierarchy as other sections

Linear issue: https://linear.app/relevance/issue/TSP-1107/

Generated with Claude Code

…to_use

Add "Creating skills programmatically" section to agent-skills.mdx covering the four structured fields (name, description, when_to_use, content), trusted skills behavior, and a code example.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Mar 26, 2026
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Mar 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Mar 26, 2026, 6:42 AM

@linear
Copy link
Copy Markdown

linear Bot commented Mar 26, 2026

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

Consolidated into #608 as part of trimming the docs-drafter queue. Branch kept; PR can be reopened if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant