docs(agent-skills): document skill directories, entry files, and frontmatter#652
Open
tembo[bot] wants to merge 1 commit into
Open
docs(agent-skills): document skill directories, entry files, and frontmatter#652tembo[bot] wants to merge 1 commit into
tembo[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Requesting review from @benja who has experience with the following files modified in this PR:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Rewrote the How it works section of
features/agent-skills.mdxso it matches how Tembo actually discovers repository skills. The previous page told readers to "place skills in the dotfile directory" (.claude/,.codex/,.opencode/,.cursor/) with no mention of the requiredskills/<name>/structure, entry filenames, or frontmatter — and its exampleSKILL.mdhad no frontmatter, so Tembo would silently skip it.Docs added/updated
.agents/skillslocation (used by Pi and Amp) and Cursor's.cursor/rules/<name>/SKILL.mdc.descriptionrequired (≤1024 chars);namerequired inSKILL.md, must match the directory name, lowercase kebab-case, ≤64 chars; Cursor.mdcderives the name from the directory; entry file must be UTF-8 text under 1 MB or it is skipped.Codepaths covered
apps/api/src/agent/worker/skills.ts—getRepositorySkillEntry(path/regex for.agents|.codex|.claude|.opencode/skills/<name>/SKILL.mdand.cursor/rules/<name>/SKILL.mdc) andparseSkillFrontmatter(name/description validation, kebab-case, length limits, 1 MB / binary guard).apps/api/src/agent/runtime/harness/*/definition.tsand.../harness/*/cli.ts— per-harnessskillDir/entryFilenamemappings for Claude Code, Codex, OpenCode, Cursor, Amp, and Pi.Key knowledge gaps addressed
.agents/skillsagent-agnostic location was entirely absent from the docs.skills/<name>/SKILL.mdlayout, that Cursor uses.cursor/ruleswith a.mdcentry file, or that frontmatter (name/description) is mandatory — the most common reasons a skill silently fails to load.Verification & scope
features/rule-files.mdx, which lists a rule-file precedence order, but found no in-repo resolver for those filenames (discovery is delegated to each harness). Evidence was inconclusive, so I left that page untouched rather than risk introducing an inaccuracy — keeping this a clean, focused, docs-only PR.main.Note
Low Risk
Documentation-only changes to agent-skills guidance; no runtime or security impact.
Overview
How it works in
features/agent-skills.mdxnow describes skills asskills/<name>/directories with a YAML frontmatter entry file, instead of vague “dotfile directory” guidance.It adds a harness → directory → entry file table (including
.agents/skillsfor Pi/Amp and Cursor’s.cursor/rules+SKILL.mdc), documents required frontmatter and validation (description,namerules forSKILL.md, Cursor naming, size/UTF-8 limits and silent skip), and updates the code-review and implementation examples with valid frontmatter and concrete paths.Reviewed by Cursor Bugbot for commit 20effa4. Bugbot is set up for automated code reviews on this repo. Configure here.