agentleFS
Md-NisarMd-Nisar/neuron/.claude/skills/add-tool/SKILL.md

add-tool

Skill1 starsChanged 8 days agoApache-2.0View on GitHub

Use when adding a new tool under src/neuron_agent/tools/, or wiring an existing tool into the agent — covers the input contract, authorization, wiring, tests, and doc updates this project requires for every tool.

20 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use add-provider and release.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • PydanticSkill

    add-provider

    Add a new inference provider to genai-prices, including provider data, matching, usage extractors, update automation, cassettes, agentic checks, generated artifacts, and Python/JavaScript/Go parity tests. Use for a new provider, not a new model on an existing provider.

    Also in 3 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 19 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No raw eval/exec/shell execution — src/neuron_agent/tools/calculator.py shows the AST-based style this project uses instead, and …

    line 15
  2. Very specific:

    Add the scope to DEV_PERMISSIONS if development should grant it.

    line 19
  3. Distinctive:

    No live LLM calls in these tests (AGENTS.md).

    line 27
  4. Distinctive:

    Update docs: if the tool mutates external state:

    line 29
  5. Very specific:

    Run the quality gates: before calling it done: make format lint typecheck test security.

    line 33

“Common” is measured: kept by at least 6 in 10 of the 19 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

Add Tool

Neuron Agent tools are bounded, and every new one must go through the same checklist (from DEVELOPMENT.md / AGENTS.md / SECURITY.md) before it's wired in. Read those three files if not already in context — this skill just sequences their requirements so none get skipped.

Steps

  1. Implement the tool under src/neuron_agent/tools/.
    • Give it a narrow, typed input contract (Pydantic model or equivalent) — no untyped dict passthrough.
    • Bound its side effects explicitly. Read-only tools are the default; anything else needs step 2's checklist.
    • No raw eval/exec/shell execution — src/neuron_agent/tools/calculator.py shows the AST-based style this project uses instead, and src/neuron_agent/tools/time.py the read-only pattern.
  2. Register it in src/neuron_agent/tools/registry.py (builtin_registry) with a ToolSpec: scope tools:<name> (none only for a public, read-only builtin) and risk read or mutating. The allow-list, scope checks and audit/span names derive from it; a tool without a spec is not callable.
    • A mutating tool needs human approval (ADR 0009 decision 6): work through the full "Future Mutating Tools" checklist in SECURITY.md (authorization outside the model, idempotency keys, retry policy, audit logs). Names on HIGH_RISK_TOOL_NAMES in security/input_policy.py are refused whatever the spec says.
    • Add the scope to DEV_PERMISSIONS if development should grant it.
  3. Wiring is automatic: agents/factory.py builds the agent from the registry.
  4. Add tests:
    • Unit test for the happy path (tests/unit/).
    • Failure-path test (bad input, bounds exceeded).
    • Security test in tests/security/ — at minimum, an unauthorized-call test; if mutating, also a duplicate-execution test.
    • No live LLM calls in these tests (AGENTS.md).
  5. Update docs if the tool mutates external state:
    • SECURITY.md — add it to the relevant section.
    • The matching ADR under docs/decisions/, or a new one if this introduces a new category of side effect.
  6. Run the quality gates before calling it done: make format lint typecheck test security.

Common mistakes

  • Registering a tool with a broader scope or a lower risk class than it deserves; read means it changes nothing outside the run.
  • Treating tool output as trusted downstream — it isn't (SECURITY.md trust boundaries).
  • Skipping the security test because "it's read-only" — read-only tools still need an unauthorized-call test if they accept any input the model controls.

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.