docs: add Cursor Cloud dev environment setup instructions - #311
Draft
dodeja wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Akshay Dodeja <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sets up and verifies the development environment for this monorepo (docs, MCP server, TypeScript SDK) and records the non-obvious cloud gotchas in
AGENTS.mdunder a new## Cursor Cloud specific instructionssection. No product code was changed.Environment setup
24.x/.tool-versions24.4.1; the VM baselinenodeis v22). A login-shell hook selects Node 24 for interactive terminals.npm ci(npm workspaces monorepo).Verification (all green under Node 24)
@terminal49/sdk)build,test -- --run,lint@terminal49/mcp)build,test -- --run,lintapi/gatewaynpx tsc --noEmit -p tsconfig.jsondocs/)npx -y mintlify@latest dev/home,/api-docs/...,/sdk/...(HTTP 200)Hello-world actions
initializehandshake, and returns its real 10-tool catalog; invokingget_supported_shipping_linesruns end-to-end (returns the server's generic error since no liveT49_API_TOKENis provisioned).Docs home page
Getting started page
API reference - List containers
Key gotcha documented
Running
mintlify devfrom inside the monorepo fails to parse page metadata for nearly every page (Failed to parse MDX files). The MDX is valid — the rootpackage.jsonoverrides(pinningzod/expressinside@mintlify/*deps) break the hoisted mintlify's parser. Workaround:cd docs && npx -y mintlify@latest dev(isolated install). Docs deploy via hosted Mintlify and CI does not run the preview, so this only affects local preview.To show artifacts inline, enable in settings.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.