Agent skill

Documented Mutations

by Opentrons in Opentrons/opentrons

Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and auditlog keys.

Apache-2.0Auto-check passedBackend & APIs

Install Documented Mutations

skills CLI
$ npx skills add Opentrons/opentrons --skill documented-mutations -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install Opentrons/opentrons documented-mutations --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/Opentrons/opentrons.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.cursor/skills/documented-mutations .claude/skills/documented-mutations && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documented-mutations
GitHub stars
521
Token cost
~662 tokens
SKILL.md length
244 words
Files
1
Skills in repo
17
Repo updated
First seen
Licence
Apache-2.0

At a glance

Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and auditlog keys.

  • Works in 2 steps: Key to AuditLogAction in… → "key": "text" in…
  • Converting mutations to documented mutations
  • SKILL.md covers Before coding, Hook (react-api-client), Callsites (app/) and Tests — update with proper mocks, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Documented Mutations is an agent skill from Opentrons/opentrons. Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and auditlog keys. Use when converting mutations to documented mutations, wiring documentationState, or adding audit log actions for access control.

Its SKILL.md is about 660 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering Authorization and RBAC. It works with React. The repository describes itself as: Software for writing protocols and running them on the Opentrons Flex and Opentrons OT-2. The licence is Apache-2.0.

When your agent uses it

  • Converting mutations to documented mutations
  • Wiring documentationState
  • Adding audit log actions for access control

Example prompts

  • “/documented-mutations”

Workflow steps

2 steps, taken from the first numbered list in SKILL.md.

  1. Key to AuditLogAction in react-api-client/src/accessControl/types.ts
  2. "key": "text" in app/src/assets/localization/en/audit_log.json only (never zh/)

What it can do on your machine

Read from SKILL.md and the folder at commit a14fef9. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documented Mutations loads about 662 tokens when it runs. Until then it costs about 73 tokens; SKILL.md has 244 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~73
When it runs · the whole SKILL.md, loaded when a task matches
~662

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Opentrons/opentrons at commit a14fef9, republished under its Apache-2.0 licence (© Opentrons). 244 words, ~662 tokens.

Download SKILL.mdSave it as .claude/skills/documented-mutations/SKILL.md (or your agent's skills folder).
name
documented-mutations
description
Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and audit_log keys. Use when converting mutations to documented mutations, wiring documentationState, or adding audit log actions for access control.

Documented Mutations

Migrate a useMutation hook to useDocumentedMutation. Copy shape from a migrated example (e.g. react-api-client/src/runs/usePlayRunMutation.ts).

Before coding

Prompt the user for an audit log key and text. Do not invent either. Then add:

  1. Key to AuditLogAction in react-api-client/src/accessControl/types.ts
  2. "key": "text" in app/src/assets/localization/en/audit_log.json only (never zh/)

Hook (react-api-client)

  1. Replace useMutation with useDocumentedMutation from ../accessControl.
  2. Require documentationState: DocumentationState as the first arg.
  3. Pass actionsToDocument as ['audit_log_key'].
  4. Mutation fn must take { variables, userNotes } (DocumentedMutationParameters) and forward userNotes to the api-client call.
  5. Ensure the api-client function accepts/sends userNotes if it does not already.

Callsites (app/)

  • Flex / shared / ODD: pass useDocumentationState() (or an existing docs state).
  • OT-2 only callsites do not need to be updated and should be passed ACCESS_CONTROL_DISABLED_DOCUMENTATION_STATE from app/src/local-resources/access-control/utils.ts.
  • Docs modal cancel: on isDocumentedMutationError, stay on the screen that launched the mutation (confirm modal, wizard step, etc.). Reset any in-flight UI; do not toast, navigate away, or apply mutation success side effects.

Tests — update with proper mocks

  • Hook tests: pass ACCESS_CONTROL_DISABLED_DOCUMENTATION_STATE from react-api-client/src/accessControl/__fixtures__/documentationState.
  • App tests: mock useDocumentationState (or pass the fixture) using ACCESS_CONTROL_DISABLED_DOCUMENTATION_STATE from app/src/local-resources/access-control/__fixtures__/documentationState.
  • Keep api-client / useHost mocks; assert userNotes is forwarded when relevant.
  • Do not add any new test files.

Checklist

  • User supplied audit log key + English text
  • AuditLogAction + en/audit_log.json updated
  • Hook uses useDocumentedMutation + userNotes
  • api-client accepts userNotes
  • Non-OT2 callsites get real docs state; OT2-only get disabled constant
  • Docs cancel restores prior screen with no changes / no user-facing error
  • Hook + app tests updated with proper mocks/fixtures

© Opentrons, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .cursor/skills/documented-mutations of Opentrons/opentrons.

Open the folder on GitHubat commit a14fef9

Compare with similar skills

Documented Mutations next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documented Mutations compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documented Mutations this skillOpentrons/opentrons521—~662Automated safety check: PassApache-2.0
Frontmcp Auth UIagentfront/frontmcp146—~3.7kAutomated safety check: PassApache-2.0
Shadmin CLIahaodev/shadmin174—~1.1kAutomated safety check: NotesMIT
Hunt Spa APIelementalsouls/Claude-BugHunter4.8k—~2.2kAutomated safety check: NotesMIT
Configuring Horizoncoollabsio/coolify63k4 repos~898Automated safety check: PassMIT
K8s Security PoliciesCybereason-Public/owLSM28012 repos~2kAutomated safety check: PassGPL-2.0

Similar skills

  • Frontmcp Auth UI

    agentfront/frontmcp

    A skill your agent uses when customizing, branding, or replacing the built-in FrontMCP OAuth pages (the login, consent, federated-select, incremental-authorization, and error pages) with your own…

    146 GitHub stars~3.7k tokensUpdated yesterday
    Backend & APIsAuto-check passed
  • Shadmin CLI

    ahaodev/shadmin

    A skill your agent uses when the user asks to query Shadmin admin platform resources (users, roles, menus, registered API resources) from a terminal — for example "list shadmin users", "show shadmin…

    174 GitHub stars~1.1k tokensUpdated 6 days ago
    Backend & APIsAuto-check: notes
  • Hunt Spa API

    elementalsouls/Claude-BugHunter

    Discover a single-page-app's hidden backend API from its public JS bundle, then test that API for broken access control / missing authentication.

    4.8k GitHub stars~2.2k tokensUpdated yesterday
    Backend & APIsAuto-check: notes
  • Configuring Horizon

    coollabsio/coolify

    A skill your agent uses whenever the user mentions Horizon by name in a Laravel context.

    63k GitHub starsUsed in 4 repos~898 tokens
    Backend & APIsAuto-check passed
  • K8s Security Policies

    Cybereason-Public/owLSM

    Comprehensive guide for implementing NetworkPolicy, PodSecurityPolicy, RBAC, and Pod Security Standards in Kubernetes.

    280 GitHub starsUsed in 12 repos~2k tokens
    Backend & APIsAuto-check passed
  • Payload

    payloadcms/payload

    A skill your agent uses when working with Payload projects (payload.config.ts, collections, fields, hooks, access control, Payload API).

    45k GitHub starsUsed in 5 repos~6.2k tokens
    Backend & APIsAuto-check passed

More from Opentrons/opentrons

All 17 skills in this repo
  • AI Client

    Opentrons/opentrons

    Conventions for the opentrons-ai-client React/TypeScript frontend — project structure, API integration, state management (Jotai), feature flags, types, and testing.

    521 GitHub stars~1.6k tokensUpdated yesterday
    Auto-check passed
  • AI Server

    Opentrons/opentrons

    Conventions for the opentrons-ai-server FastAPI service — project structure, uv dependency management, settings, testing, Docker, and deployment.

    521 GitHub stars~2.5k tokensUpdated yesterday
    Auto-check: notes
  • Analyses Snapshot Testing

    Opentrons/opentrons

    Conventions for the analyses snapshot testing framework in analyses-snapshot-testing/.

    521 GitHub stars~1.7k tokensUpdated yesterday
    Auto-check passed
  • CSS Modules

    Opentrons/opentrons

    CSS Modules conventions, Stylelint rules, design tokens (spacing, colors, typography, border-radius), and patterns for the Opentrons monorepo.

    521 GitHub stars~2.2k tokensUpdated yesterday
    Auto-check passed
  • Docs

    Opentrons/opentrons

    Authoring and styling guidelines for the Opentrons /docs MkDocs project.

    521 GitHub stars~2.8k tokensUpdated yesterday
    Auto-check passed
  • E2E Testing

    Opentrons/opentrons

    E2E testing conventions for Protocol Designer and Labware Library using Playwright + pytest in e2e-testing/.

    521 GitHub stars~3k tokensUpdated yesterday
    Auto-check: notes

Works with

Categories

Questions about Documented Mutations

What does Documented Mutations do?

Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and auditlog keys. Documented Mutations is an agent skill from Opentrons/opentrons. Migrate react-api-client useMutation hooks to useDocumentedMutation and update app callsites, tests, api-client userNotes, and auditlog keys.

When should I use Documented Mutations?

Documented Mutations fits situations like: converting mutations to documented mutations; wiring documentationState; adding audit log actions for access control.

How do I install Documented Mutations in Claude Code?

Run `npx skills add Opentrons/opentrons --skill documented-mutations -a claude-code`. Or copy the skill folder (.cursor/skills/documented-mutations in Opentrons/opentrons) into .claude/skills/documented-mutations in your project. Claude Code loads it when a task matches its description.

How do I install Documented Mutations in Codex?

Run `npx skills add Opentrons/opentrons --skill documented-mutations -a codex`. Or copy the skill folder (.cursor/skills/documented-mutations in Opentrons/opentrons) into .agents/skills/documented-mutations in your project. Codex loads it when a task matches its description.

Can I use Documented Mutations in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Opentrons/opentrons --skill documented-mutations -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documented-mutations, .gemini/skills/documented-mutations, .github/skills/documented-mutations and .opencode/skills/documented-mutations in your project.

What does Documented Mutations need to run?

SKILL.md names no scripts, command-line tools or credentials: Documented Mutations is instructions for the agent only.

Does Documented Mutations access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documented Mutations safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documented Mutations use?

Documented Mutations is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documented Mutations use?

About 662 tokens (SKILL.md is roughly 2.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documented Mutations?

Skills that share tags, products or a category with Documented Mutations: Frontmcp Auth UI (agentfront/frontmcp, 146 stars), Shadmin CLI (ahaodev/shadmin, 174 stars), Hunt Spa API (elementalsouls/Claude-BugHunter, 4.8k stars) and Configuring Horizon (coollabsio/coolify, 63k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documented Mutations?

Opentrons (a GitHub organization) maintains it in Opentrons/opentrons, which has 521 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on October 7, 2026.

Source: Opentrons/opentrons on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.