diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..021943f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,20 @@ +# AGENTS.md + +## Cursor Cloud specific instructions + +This is a single-package TypeScript library (`@codelytv/mcp-client`) — not a monorepo, no services to run. + +### Key commands + +| Task | Command | +|------|---------| +| Install deps | `npm install` | +| Lint | `npm run lint` | +| Build | `npm run build` (runs `tsc`) | +| Tests | `npx jest --roots tests --transform '{"^.+\\.tsx?$": "ts-jest"}'` | + +### Notes + +- There is no `test` script in `package.json`; Jest and ts-jest are installed as devDependencies. Run tests with the command above. +- The project compiles to ESM (`module: "ESNext"` in tsconfig). The compiled `dist/` output cannot be directly `require()`d or run with plain `node` due to missing `.js` extensions in import paths. Use `npx tsx` to run TypeScript source directly if needed. +- CI (`.github/workflows/ci.yml`) runs: `npm install` → `npm run lint` → `npm run build`. There are no test steps in CI.