RuleScan: pass
ConnectionGuide.txt format rule
Auto-attached rule that keeps a per-repo ConnectionGuide.txt of ports, routes, connections, and integration env vars current.
Add a trust badge to your README
[](https://waxmark.app/items/cursor-rule-connection-guide/scan)
--- description: Format for ConnectionGuide.txt — the per-repo log of ports, routes, connections, and integration env vars. Attached when server, API, or config files are in scope. globs: **/api/**,**/server/**,**/routes/**,**/middleware.*,**/*.config.*,**/docker-compose*,**/Dockerfile*,**/.env.example,**/ConnectionGuide.txt,**/foundry.toml,**/hardhat.config.*,**/Anchor.toml alwaysApply: false --- # Connection Guide Maintain `ConnectionGuide.txt` at the project root. Create it if missing. Update it in the same step as the change, not afterward. ## What to log - HTTP and API routes (method, path, purpose, auth) - WebSocket URLs or channels - Server ports and host bindings - Database connections and pool config, by env var name - External services: APIs, webhooks, SDKs, RPC endpoints, program or contract addresses - Environment variables that affect connectivity ## Format One section per service or subsystem. Each entry gives the port or base URL (or the env var that sets it), method and path for routes, a one-line purpose, and auth requirements if any.