agentleFS
get-convexget-convex/agent-skills/AGENTS.md

agent-skills

AGENTS.md68 starsChanged 14 days agoApache-2.0View on GitHub

Rules for contributing to this repository. Skills in this repository should be narrowly focused on a specific task or workflow. A good skill helps an agent take a concrete action, for example: Do not create skills that mainly provide generic background information or broad documentation. If content is mostly reference material, it should usually live in docs, not as a standalone skill. Reference material is fine inside a skill when it directly helps complete the task the skill is for.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

13 rules. About 0 are common, 9 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    create a Convex function

    line 14
  2. Distinctive:

    Do not create skills that mainly provide generic background information or broad documentation.

    line 17
  3. Distinctive:

    Before contributing, review the core Agent Skills docs:

    line 24
  4. Distinctive:

    If the skill uses bundled scripts, also review Using scripts in skills.

    line 32
  5. Very specific:

    Use Yes/No in tables instead of checkmarks or emoji

    line 38
  6. Distinctive:

    Keep examples concise and focused

    line 39
  7. Very specific:

    Use // Bad: and // Good: comments in code examples

    line 40
  8. Very specific:

    Follow existing file patterns in skills/

    line 41
  9. Distinctive:

    If skills are added, removed, renamed, or substantially repositioned, update the root README.md

    line 55
  10. Very specific:

    Keep the skill list in the root README.md in sync with the current contents of skills/

    line 57
  11. Distinctive:

    Do not assume a skill is good just because it reads well

    line 62
  12. Distinctive:

    If human intervention is required, stop and ask explicitly for the exact step needed

    line 65
  13. Distinctive:

    After the run, feed what you learned back into the skill with clearer instructions, steps, gotchas, or validation checks

    line 67

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Instructions

Rules for contributing to this repository.

Skill Philosophy

Skills in this repository should be narrowly focused on a specific task or workflow.

A good skill helps an agent take a concrete action, for example:

  • set up authentication
  • design a schema
  • create a Convex function
  • plan a migration

Do not create skills that mainly provide generic background information or broad documentation. If content is mostly reference material, it should usually live in docs, not as a standalone skill.

Reference material is fine inside a skill when it directly helps complete the task the skill is for.

Before contributing, review the core Agent Skills docs:

If the skill uses bundled scripts, also review Using scripts in skills.

Style Guidelines

  • No emojis in any markdown files or code comments
  • Use Yes/No in tables instead of checkmarks or emoji
  • Keep examples concise and focused
  • Use // Bad: and // Good: comments in code examples
  • Follow existing file patterns in skills/

File Structure

Each skill should have:

  • Clear heading with brief description
  • "When to Use" section
  • Code examples showing bad vs good patterns
  • Complete, runnable examples
  • Checklist at the end

Maintenance

  • If skills are added, removed, renamed, or substantially repositioned, update the root README.md
  • Keep the skill list in the root README.md in sync with the current contents of skills/

Validation

  • Do not assume a skill is good just because it reads well
  • Validate skills by trying to use them in a realistic temp project or sandbox
  • Push the task as far as possible without human help
  • If human intervention is required, stop and ask explicitly for the exact step needed
  • After the run, feed what you learned back into the skill with clearer instructions, steps, gotchas, or validation checks
  • For UI-facing skills, validate the browser flow as part of skill authoring, not just the code or CLI steps

Code Examples

// Bad: description of the problem

// Good: description of the solution

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.