Skip to content

Feat/ts server cli#135

Open
kartikloops wants to merge 62 commits into
The-OpenROAD-Project:feat/ts-migrationfrom
kartikloops:feat/ts-server-cli
Open

Feat/ts server cli#135
kartikloops wants to merge 62 commits into
The-OpenROAD-Project:feat/ts-migrationfrom
kartikloops:feat/ts-server-cli

Conversation

@kartikloops

Copy link
Copy Markdown
Collaborator

This PR adds the layer that actually boots the MCP server. The engine and all 10 tools already existed on feat/ts-tools; this connects them to MCP transports, a CLI, and graceful shutdown so that node dist/main.js (and later npx openroad-mcp) runs as a real server.

The work is split across four files. src/server.ts registers all 10 tools with their Zod schemas and behavior annotations (ported straight from the Python server.py) and runs them over either stdio or HTTP. src/config/cli.ts parses the command-line flags and rejects --host/--port unless you're on HTTP. src/utils/cleanup.ts handles SIGTERM/SIGINT, signals shutdown, and force-exits if a graceful stop hangs. src/main.ts ties it together: parse the CLI, set up logging, run the server, and exit with sensible codes. Tests cover the CLI, the cleanup manager, and an in-memory server boot that confirms all 10 tools show up.

HTTP runs in stateless mode with a fresh transport and server per request, because the SDK forbids reusing one transport and two clients numbering their requests from the same id would otherwise collide. Session continuity still works since sessions are keyed by our own session_id, not the MCP transport. In main.ts, logging and server are imported dynamically (not statically) so that a bad env var fails cleanly instead of crashing during module load, and so the CLI log level is applied before any logger is built. Lastly, tsconfig.json flips skipLibCheck to true: the SDK's HTTP transport types don't satisfy our strict exactOptionalPropertyTypes, so lib checking has to be skipped to use it. Our own source stays fully type-checked.

Everything is verified: typecheck and lint are clean, all 420 tests pass with 85.7% line coverage, and the server was tested live in Cursor and it boots over stdio, lists all 10 tools, spawns a real OpenROAD process and runs commands, handles concurrent HTTP requests without collisions, and shuts down cleanly on Ctrl-C. A bad env var produces a clear configuration error and exit code 1.

To run it, build with cd typescript && npm run build, then point your MCP client at it:

{
"mcpServers": {
"openroad-mcp": {
"command": "node",
"args": ["/absolute/path/to/typescript/dist/main.js"]
}
}
}

kartikloops and others added 30 commits June 16, 2026 11:31
* add vscode workspace settings for typescript sdk path

* add plan doc

* add core session state and error models

* add interactive session error models

* add circular buffer for pty output

* add pty handler for managing node-pty processes

* add interactive session manager

* add tests for circular buffer

* add tests for command validation

* add tests for pty handler

* add tests for interactive session

* update eslint config with coverage ignore and stricter rules

* fix pending waiters, env cast and resolver types in pty handler

* guard read chunk size against zero in session onData handler

* add test for cleanup resolving pending waitForExit waiters

* add real openroad repl integration check script

* code cleanup

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kartik Mittal <100078751+kartikloops@users.noreply.github.com>

* added case for READ_CHUNK_SIZE is larger than limit

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kartik Mittal <100078751+kartikloops@users.noreply.github.com>

* fix isAlive signaling shutdown when process death is detected

* add test for isAlive shutdown signal on process death

* fix force terminate returning before alive flag clears

* update tests for force terminate waiting for exit

* fix terminate not disposing pty listeners and pending waiters

* update terminate tests to assert pty cleanup is called

* fix clear not waking pending waitForData callers

* add regression test for clear waking pending waitForData callers

* signal shutdown in readOutput drain path so writer task does not loop indefinitely

* add regression test for readOutput signaling shutdown on dead session

* fix waitForData not re-checking dataAvailable under mutex after runExclusive

* add regression test for waitForData race between fast-path check and mutex

* handle append rejection in onData handler to avoid silent data loss

* add regression test for append rejection transitioning session to terminated

* move MacOSPTYHandler to production and add create_pty_handler factory

* use create_pty_handler so macOS gets the keepalive and drain subclass

* remove duplicate MacOSPTYHandler from test file and import from production

* remove MacOSPTYHandler and create_pty_handler — not needed for PoC

* await SIGKILL exit in terminateProcess so cleanup cannot race the exit listener

* block path traversal sequences in validateCommand argument check

* reject absolute paths in python validateCommand to match typescript behavior

* truncate single oversized chunk to maxSize to enforce capacity invariant

* throw on unrecognised boolean env vars and lazily init settings to prevent silent security disable

* fix ansi decoder escape coverage, annotate mode cr handling, mode validation and pre-compile sequence patterns

* wait for exit after kill() throw to observe natural death rather than returning blind

* bound waitForExit after SIGKILL to 5s to prevent indefinite hang on D-state processes

* revert python absolute path change and align typescript to accept absolute paths via basename check

* revert python pty handler and integration test to main

---------

Signed-off-by: Kartik Mittal <100078751+kartikloops@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…t can map config and interrupt failures to distinct exit codes
…exit timer so a hung graceful shutdown still exits after FORCE_EXIT_DELAY_SECONDS
…re asserted to enumerate with correct annotations
…ing logging and server so settings validate before any logger is built and the CLI log level applies first
…ncurrent stateless clients do not collide on JSON-RPC request ids
Copilot AI review requested due to automatic review settings June 25, 2026 06:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@kartikloops kartikloops requested review from luarss and vvbandeira June 25, 2026 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants