agent-readablelisted

Use agent_readable to get authoritative usage guidance for Python classes, modules, functions, and methods before writing code against them, and to make new Python APIs agent-readable. Activate when writing or modifying Python code that calls into a class, module, function, or method from any library, OR when adding/changing a public Python API. Covers calling `agent_help(obj)` for structured docs + behavioral rules, and authoring docstrings + `__agent_notes__()` so usage rules travel with the code.
zydo/agent-readable · ★ 5 · AI & Automation · score 77

Install: claude install-skill zydo/agent-readable

# agent-readable `agent-readable` is a tiny Python library (`pip install agent-readable`, zero runtime deps, Python 3.10+) that gives any class, module, function, or method a structured, agent-oriented "usage guide" — the canonical answer to *how do I correctly use this?* — produced by one call: `agent_help(obj)`. This skill teaches you two jobs: 1. **Consume** — before writing Python code that uses a class, module, function, or method, call `agent_help(target)` and use the output as the source of truth. 2. **Author** — when adding or modifying a public Python API, make it agent-readable so future agents get correct usage on the first try. **Current language support:** Python 3.10+. Counterparts in other languages are on the roadmap; when they ship, this skill will gain sections for them and the same trigger will fan out across languages. ## When to activate this skill * The user asks you to write, modify, or refactor Python code that calls into a class, module, function, or method (from a third-party library or from this project). * The user asks you to add or change a public Python class, module, or function (especially one other code or other agents will use). * The user mentions `agent_help`, `__agent_notes__`, `AgentReadableMixin`, the `AgentReadable` protocol, or the `agent-readable` library by name. ## Install ```bash pip install agent-readable # or: uv add agent-readable ``` Python 3.10+. No runtime dependencies. The library exposes one top