Skip to content

Add AGENTS.md with cloud-specific development instructions #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JavierCane wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Draft

Add AGENTS.md with cloud-specific development instructions #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading