agentleFS
Wsh7AshWsh7Ash/skillmcp/skills/error-shape-for-agents/SKILL.md

error-shape-for-agents

Skill0 starsChanged 14 days agoMITView on GitHub

Return errors an agent can act on: what failed, why, and the next call that would work. Use when a tool can fail because of bad arguments, missing files or an empty result

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use JSON-RPC errors for malformed requests and invalid params

    line 21
  2. Distinctive:

    Use a tool result with isError for failures inside a valid call

    line 22
  3. Distinctive:

    Never return a bare stack trace as the only content

    line 25
  4. Distinctive:

    no traceback reaches the client

    line 32

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Error Shape For Agents

Return errors an agent can act on: what failed, why, and the next call that would work

Use when: a tool can fail because of bad arguments, missing files or an empty result

Avoid when: the tool cannot fail, such as a constant return

Procedure

  1. Separate protocol errors from tool-level failures
  2. Use JSON-RPC errors for malformed requests and invalid params
  3. Use a tool result with isError for failures inside a valid call
  4. Name the failing input and the accepted shape in the message
  5. Suggest the next call, such as list_packs when a slug is unknown
  6. Never return a bare stack trace as the only content

Signals

  • an unknown slug returns isError with a suggestion to list packs
  • invalid params carry the offending key name
  • the message distinguishes not-found from unreadable
  • no traceback reaches the client

Patterns

1. Tool failure

{"content": [{"type": "text", "text": "..."}], "isError": true}

2. Protocol failure

{"error": {"code": -32602, "message": "invalid params"}}

3. Actionable text

unknown skill 'x'; try search_skills first

Pitfalls

  • Returning isError for a malformed request instead of a JSON-RPC error
  • Leaking a filesystem path or a stack trace into the tool result
  • Returning success with empty content when the lookup failed

Done when

  • protocol errors and tool failures are distinguishable by shape
  • each error names the input and suggests a next step

References

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.