agent-readable-ts

agent-readable-ts helps coding agents inspect the live public surface of a TypeScript or JavaScript API before they write code against it.

Library authors can add agent-oriented usage rules next to a class, object, or function. Consumers call agentHelp(target) or the agent-readable-ts CLI to get compact Markdown with the real callable surface plus any author-supplied behavioral notes.

To let your coding agent automatically call agentHelp() before using an unfamiliar API, install the companion skill:

npx skills add zydo/skills --skill agent-readable

import { agentHelp } from "agent-readable-ts";

class Sensor {
  calibrate(offset: number): void {}
  read(): number {
    return 0;
  }

  agentNotes(): string {
    return "- Call `calibrate()` once during setup, before `read()`.";
  }
}

console.log(agentHelp(new Sensor()));

Install

npm install agent-readable-ts

For one-off CLI use, two parallel series:

npx agent-readable-ts commander        # npm series
pnpm dlx agent-readable-ts commander   # pnpm series

See Getting Started for both series, repeated-use installs, and full CLI usage.

Documentation

• Getting Started
• Why agent-readable-ts?
• Examples
• Authoring Notes
• FAQ

Other Languages

• Python: agent-readable provides the same idea for Python packages and classes.

License

MIT