agentleFS
ulises-jeremiasulises-jeremias/agent-toolkit/skills/core/assistant/SKILL.md

assistant

Skill19 starsChanged 2 months agoMITView on GitHub

Assistant — on any repo, scan README→docs→AGENTS→CONTRIBUTING→PR templates→task runners→devcontainer→CI→configs

We split this skill into the rules it gives an agent

14 rules. 0 are common, 7 are distinctive, and 7 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Stay portable: avoid recommending workflows that only work in one IDE unless the repo is explicitly single-tool.

    line 37
  2. Distinctive:

    Use this sequence for the opened repository root (or the subpackage root you are changing in a monorepo).

    line 43
  3. Very specific:

    Monorepos: run the table for the root first, then repeat for the specific package/service directory if it has its own README, package.json, …

    line 58
  4. Distinctive:

    If AGENTS.md exists: treat it as the single portable source of truth for agent guardrails.

    line 74
  5. Very specific:

    When suggesting a new rule, check it does not duplicate CONTRIBUTING.md or AGENTS.md.

    line 99
  6. Distinctive:

    Prefer one canonical place per concern (e.g.

    line 100
  7. Distinctive:

    Use this to choose tone and strictness:

    line 106
  8. Distinctive:

    No way to run tests or lint from documented commands.

    line 121
  9. Very specific:

    When the open repo is (or includes) / chezmoi home/:

    line 133
  10. Very specific:

    Read repo root AGENTS.md, docs/*.md, home/.chezmoidata/*, home/.chezmoiscripts/*.tmpl, home/dot_local/share//.chezmoiexternal.toml.tmpl as …

    line 135
  11. Distinctive:

    When a developer asks about setup, getting started, or validation:

    line 145
  12. Very specific:

    If issues found: Run doctor and address failures.

    line 168
  13. Very specific:

    Use skill-catalog.yaml next to bundled skills for domains, triggers and depends_on.

    line 183
  14. Very specific:

    No secrets in repos; use env patterns documented for the project and env.d where applicable.

    line 222

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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
SKILL.md

Assistant

Organizational companion for anyone building **for ** in any repository (client, internal, or ``). It tells the agent what to open first, why, and how to resolve conflicts—without copying content that already lives in the project.

Orchestration

This skill is the default orchestrator and fallback for agent work. Read references/ORCHESTRATION.md for routing (workflows, tool skills, delegation phrasing). Use ~/.local/share//skills/skill-catalog.yaml (bundled next to skills) for domain, WHAT vs HOW, triggers, and depends_on per skill. Workflow skills define phases and gates only; tool skills own CLI procedures—do not inline HOW steps inside workflow skills.

Hard rules

  • Derive answers from files in the repo and **machine-local agent-toolkit baseline (~/.local/share/agent-toolkit/). Cite paths when you recommend workflows.
  • Do not paraphrase long sections of README/docs into chat when a link or path is enough; do not invent scripts or flags that are not documented or discoverable.
  • AGENTS.md (when present) is the primary contract for agent behavior in that repo; see Agent instruction map for tie-breakers with tool-specific files.

Extended path hints: references/REPO_INSPECTION.md. Orchestration: references/ORCHESTRATION.md. Starter AGENTS.md for new projects: references/AGENTS_TEMPLATE.md (and chezmoi AGENTS.project.md.tmpl in the baseline templates).


Expected behavior

  1. On entering a task in a repo, spend a short discovery pass: follow Repository inspection order before editing large areas of code.
  2. Classify documentation you find (see Documentation taxonomy) so you do not apply contributor-only rules to end-user docs or vice versa.
  3. Prefer official automation from Makefile / justfile / package.json / CI over ad-hoc commands.
  4. When advising, name the source file (“per CONTRIBUTING.md…”, “.github/workflows/ci.yml runs…”).
  5. If something is missing (no tests doc, no AGENTS, conflicting instructions), say so and suggest a concrete addition—optionally offer to draft from references/AGENTS_TEMPLATE.md.
  6. Stay portable: avoid recommending workflows that only work in one IDE unless the repo is explicitly single-tool.

Repository inspection order

Use this sequence for the opened repository root (or the subpackage root you are changing in a monorepo). Skips are fine if a path does not exist—document what you skipped.

StepWhereWhat to extract
1README.md (root; then local README in the package you touch)Purpose, how to run locally, stack, basic commands, high-level layout
2docs/, doc/, documentation/, or project wiki mirrorArchitecture, domain flows, conventions, ADRs, operational runbooks
3AGENTS.md (root; if missing, docs/AGENTS.md)Agent-specific rules, restrictions, repo-specific workflows
4CONTRIBUTING.md (or docs/CONTRIBUTING.md)Branch/commit/PR norms, quality bar, review process
5PR templates: .github/pull_request_template.md, .github/PULL_REQUEST_TEMPLATE.md, .github/PULL_REQUEST_TEMPLATE/*Expected PR content, checklists, Definition of Done
6Makefile, justfile, package.json scripts, Taskfile.yml, mise.toml, pyproject.toml scriptsOfficial build / test / lint / dev commands
7.devcontainer/devcontainer.json, compose.yaml / docker-compose.yml, DockerfileHow the team expects the dev environment to run
8.github/workflows/*, .gitlab-ci.yml, Jenkinsfile, etc.Mandatory checks, test matrix, deploy vs PR gates
9Config: tsconfig, ESLint/Prettier/Biome, Ruff/mypy, Jest/Vitest/Playwright, etc.Implicit style and testing conventions
10Source treeImplementation after steps 1–9 give context

Monorepos: run the table for the root first, then repeat for the specific package/service directory if it has its own README, package.json, or CI job names that differ.


Agent instruction map

These files shape how the assistant should behave. Discover them with Glob, then Read.

KindTypical pathsRole
Portable agent contractAGENTS.mdHighest priority for agent behavior in this repo when present
Cursor.cursor/rules/**, .cursorrulesIDE-specific; must not silently override AGENTS without acknowledgment
Claude / Claude CodeCLAUDE.md, .claude/**Tool-specific project memory
Copilot.github/copilot-instructions.md, documented Copilot instruction pathsMicrosoft/GitHub-specific
Gemini / Cloud Code / otherGEMINI.md, vendor “cloud” or IDE instruction pathsTool-specific; keep thin if AGENTS.md exists

If AGENTS.md exists: treat it as the single portable source of truth for agent guardrails. Tool files should align with it; if they diverge, surface the conflict to the user and default to AGENTS.md unless the user says otherwise.

If AGENTS.md is missing but .cursor/rules or CLAUDE.md exist: follow those and suggest adding a root AGENTS.md that links or summarizes them for portability (Cursor, Copilot, Claude Code, Cloud Code, etc.).

If only cloud / vendor markdown exists (e.g. single-vendor “cloud” instructions): recommend evaluating AGENTS.md plus short tool stubs so the same rules travel across tools.


Conflict resolution heuristics

| Situation | Resolution | | --- | --- | --- | | README says “run npm start”, package.json has no start | Trust package.json; note README drift | | AGENTS.md vs CONTRIBUTING.md on process | CONTRIBUTING for human Git flow; AGENTS for what the agent may automate or touch | | AGENTS.md vs .cursor/rules | AGENTS.md wins for stated agent behavior; flag contradiction | | Local package README vs root README | Local for that package’s commands; root for global architecture | | Docs vs code | Docs describe intent; if code disagrees, report mismatch instead of guessing which is “right” | | CI does not run a script the README claims is mandatory | CI config is authoritative for merge gates; suggest doc fix |


Anti-duplication and citation

  • Summarize README/docs in your own words only when needed for the task; otherwise point to the file and section.
  • Never paste entire policy documents into replies; extract actionable bullets and cite the path.
  • When suggesting a new rule, check it does not duplicate CONTRIBUTING.md or AGENTS.md.
  • Prefer one canonical place per concern (e.g. “all PR rules in template + CONTRIBUTING”).

Documentation taxonomy

Use this to choose tone and strictness:

TypeExamplesUse for
General / productRoot README, user guidesWhat the product is, how to run it
ContributorsCONTRIBUTING, PR template, code review guideBranches, commits, review, quality
AgentsAGENTS.md, tool instruction filesWhat assistants may or must not do
Operational / technicalRunbooks, ADRs, architecture under docs/Deploy, incidents, technical decisions

Documentation gap signals

Flag gaps explicitly when you notice:

  • No way to run tests or lint from documented commands.
  • README references scripts that do not exist.
  • CI enforces checks not mentioned for contributors.
  • Multiple conflicting instruction files with no hierarchy.
  • Sensitive operations (migrations, prod) undocumented.

Offer small, copy-ready fixes (e.g. a minimal AGENTS.md from references/AGENTS_TEMPLATE.md).


workstation baseline (optional layer)

When the open repo is (or includes) `` / chezmoi home/:

  • Read repo root AGENTS.md, docs/*.md, home/.chezmoidata/*, home/.chezmoiscripts/*.tmpl, home/dot_local/share//.chezmoiexternal.toml.tmpl as needed.
  • For agent-toolkit commands, run agent-toolkit --help.

On any machine with the baseline applied:

  • ~/.local/share// — bundled skills, templates, MCP examples, skills-registry.yaml.
  • skills list, doctor, loadenv — operational discovery.

New Developer Onboarding

When a developer asks about setup, getting started, or validation:

  1. First-time setup (cite docs/wiki/TECHNICAL_QUICKSTART.md):
    git clone git@github.com:ulises-jeremias/.git
    cd 
    chezmoi init --source=. -c ~/.config/chezmoi/.toml
    chezmoi apply --source=. -c ~/.config/chezmoi/.toml --dry-run
    chezmoi apply --source=. -c ~/.config/chezmoi/.toml
  2. Post-setup validation:
    doctor
    Expected: result: COMPLIANT
  3. AI tools verification:
    opencode --version  # or claude --version, etc.
    ls ~/.config/opencode/skills/
  4. If issues found: Run doctor and address failures. For persistent issues, escalate via update-check and contact #tech-support.

Helpful Commands for Developers

TaskCommand
Validate setupdoctor
Check updatesupdate-check
Update workstationchezmoi update && chezmoi apply --source=. -c ~/.config/chezmoi/.toml
List AI skillsskills list
Sync skillsskills sync
Health checktriage (runs doctor, layout checks)

Where to route next (bundled HOW skills)

Use skill-catalog.yaml next to bundled skills for domains, triggers and depends_on. Prefer one workflow driver per task (dev-companion + workflow-generic-project for generic delivery).

AreaSkill(s)Notes
GitHub PR review threadsgh-address-commentsCurrent-branch PR; pairs with github-cli-workflow for push/PR updates
GitHub Actions failuresgh-fix-ciFetch logs + snippet; plan before coding; pairs with planning
Merge / rebase conflictsfix-merge-conflictsResolve conflict markers; preserve authorship
Prose / docs anti-slopunslopPR text, comments, docs before final review
Diff-scoped code cleanupdeslopRedundant code in changed hunks only
Change impact / scopeblast-radiusBefore large refactors; pairs with architect / planner
Agent-facing CLI designcli-for-agentsBuilding or reviewing CLIs for agent use
Workspace learningsworkspace-knowledge-syncPersist facts/todos across sessions
Draft PR / MRgithub-cli-workflow, gitlab-cli-workflowAfter output-handshake / pr-fallback when needed
LinearlinearLinear MCP (OAuth); issues, cycles, docs
Figmafigma (entry), figma-implement-design, figma-code-connect-components, figma-create-design-system-rules, figma-create-new-fileMCP templates under ~/.local/share//mcp/figma/
Figma designfigma / figma-implement-designDesign-to-code via Figma MCP; use figma-create-design-system-rules for system rules
Immersive scroll storyscroll-worldAuthored scroll-driven product journey; paid video pipeline requires explicit approval
Playwrightplaywright-cliCLI browser automation from the shell
Playwright test specse2e-runnerNot the same as playwright-cli
Jupyter notebooksjupyter-notebookScaffold via newnotebook
Workstation healthtriagedoctor, doctor --issue
Slackslack-cli, slack-assistantApp CLI vs workspace chat
Tickets (external packs)clickup-cli, jira-, confluence-As installed via registry / chezmoiexternal
Datadbt-validation, snowflake-validationRead-only validation patterns

Client/account overlays live in the workspace (~/.ai-workspace/packs/ + knowledge/) and should be loaded when triggered.

For AI agent assistance, invoke agents using @mention in your message (NOT the Task tool): @planner (feature planning), @code-reviewer (code review), @security-reviewer (security), @tdd-guide (TDD workflow), @researcher + delivery/spike (examples from public examples via researcher/references/LOOKUP_GUIDE.md). Agents are defined in ~/.config/opencode/agents/ — they are NOT skills and must NOT be loaded via the skill tool.


Organization playbooks

Client delivery workflows and the skill catalog live under ~/.local/share//skills/. Read what is installed; do not invent URLs.


Safety

  • No secrets in repos; use env patterns documented for the project and env.d where applicable.
  • Destructive or prod-affecting steps require explicit human confirmation unless AGENTS.md clearly authorizes them.

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.