docs: add AGENTS.md with Cursor Cloud specific instructions

[avivkeller]

Description

Adds AGENTS.md with Cursor Cloud specific instructions for setting up and developing in this codebase. This file documents:

• Runtime requirements (Node.js 24)
• Key dev commands (lint, test, format, run CLI)
• How to run the tool locally with sparse-cloned Node.js API docs
• Non-obvious caveats discovered during setup

Validation

Full development environment verified:

• Node.js 24 installed and active (per .nvmrc)
• npm install completed successfully
• Lint passes (0 errors, 2 pre-existing warnings)
• Format check passes
• All 403 tests pass (0 failures)
• CLI runs end-to-end: generated both legacy-html and web output for fs.md

Generated Node.js fs module docs (web generator)

Test results (403/403 passing):
test_output.log

Related Issues

N/A — Development environment setup

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run node --run test and all tests passed.
• I have check code formatting with node --run format & node --run lint.
• I've covered new added functionality with unit tests if necessary.

_{To show artifacts inline, enable in settings.}

  

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Apr 6, 2026 8:55pm

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.42%. Comparing base (b2330d9) to head (8246a14).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #755   +/-   ##
=======================================
  Coverage   78.42%   78.42%           
=======================================
  Files         157      157           
  Lines       13959    13959           
  Branches     1152     1152           
=======================================
  Hits        10948    10948           
  Misses       3006     3006           
  Partials        5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

api-links Generator

apilinks.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    'Agent.defaultMaxSockets': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L227',
    'Buffer.alloc': 'https://github.com/nodejs/node/blob/HEAD/lib/buffer.js#L436',
    'Buffer.allocUnsafe': 'https://github.com/nodejs/node/blob/HEAD/lib/buffer.js#L450',
    'Buffer.allocUnsafeSlow': 'https://github.com/nodejs/node/blob/HEAD/lib/buffer.js#L462',
...
    'agent.addRequest': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L292',
+   'agent.createConnection': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L231',
-   'agent.createConnection': 'https://github.com/nodejs/node/blob/HEAD/lib/https.js#L326',
    'agent.createSocket': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L363',
    'agent.destroy': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L595',
+   'agent.getName': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L261',
-   'agent.getName': 'https://github.com/nodejs/node/blob/HEAD/lib/https.js#L484',
    'agent.keepSocketAlive': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L552',
    'agent.removeSocket': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L491',
    'agent.reuseSocket': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_agent.js#L588',
    'assert.assert': 'https://github.com/nodejs/node/blob/HEAD/lib/assert.js#L185',
    'asyncResource.asyncId': 'https://github.com/nodejs/node/blob/HEAD/lib/async_hooks.js#L242',
...
    'server.address': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2289',
+   'server.close': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L614',
+   'server.closeAllConnections': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L624',
+   'server.closeIdleConnections': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L636',
-   'server.close': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2422',
-   'server.closeAllConnections': 'https://github.com/nodejs/node/blob/HEAD/lib/https.js#L120',
-   'server.closeIdleConnections': 'https://github.com/nodejs/node/blob/HEAD/lib/https.js#L122',
    'server.getConnections': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2384',
    'server.listen': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2106',
    'server.ref': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2527',
+   'server.setTimeout': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L652',
-   'server.setTimeout': 'https://github.com/nodejs/node/blob/HEAD/lib/https.js#L124',
    'server.unref': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2536',
+   'server[SymbolAsyncDispose]': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L620',
+   'server[undefined]': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L659',
-   'server[SymbolAsyncDispose]': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2462',
-   'server[undefined]': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L2491',
    'serverresponse._finish': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L246',
    'serverresponse._implicitHeader': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L360',
    'serverresponse.assignSocket': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L296',
    'serverresponse.detachSocket': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L307',
    'serverresponse.statusCode': 'https://github.com/nodejs/node/blob/HEAD/lib/_http_server.js#L269',
...
    'socket.addSourceSpecificMembership': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L926',
+   'socket.address': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L815',
-   'socket.address': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L714',
    'socket.bind': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L267',
    'socket.close': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L778',
+   'socket.connect': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L412',
-   'socket.connect': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L1281',
    'socket.destroySoon': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L856',
    'socket.disconnect': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L490',
    'socket.dropMembership': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L911',
    'socket.dropSourceSpecificMembership': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L944',
    'socket.end': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L795',
...
    'socket.read': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L839',
+   'socket.ref': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L1001',
-   'socket.ref': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L1621',
    'socket.remoteAddress': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L827',
    'socket.resetAndDestroy': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L801',
    'socket.resume': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L830',
    'socket.send': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L615',
    'socket.sendto': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L504',
...
    'socket.setTypeOfService': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L661',
+   'socket.unref': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L1011',
-   'socket.unref': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L1635',
    'socket[SymbolAsyncDispose]': 'https://github.com/nodejs/node/blob/HEAD/lib/dgram.js#L802',
    'socket[kAfterAsyncWrite]': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L990',
    'socket[kReinitializeHandle]': 'https://github.com/nodejs/node/blob/HEAD/lib/net.js#L1349',
    'string_decoder.StringDecoder': 'https://github.com/nodejs/node/blob/HEAD/lib/string_decoder.js#L60',
    'timers.clearImmediate': 'https://github.com/nodejs/node/blob/HEAD/lib/timers.js#L226',

[MattIPv4]

I don't think this is documenting anything novel? And if it is, I would think we might be better off encoding it into our contributing docs instead, so that folks that aren't using agents can also benefit from the knowledge?