iptime-mcp: Instructions file for Codex

iptime-mcp contributor instructions

Project scope

This repository implements a local stdio MCP server for ipTIME router administration. Keep the server transport-focused, auditable, and safe around network-changing operations. Do not add unrelated applications, generated reports, work logs, or scratch artifacts.

Required checks

Run these commands after code changes:

npm run lint
npm test
npm run build

Run npm pack --dry-run after changing package metadata, entry points, build output, or public documentation. Tests must use loopback mock servers; never use a real router for automated write tests.

Code map

• src/server.ts: MCP tools, resources, schemas, and server instructions
• src/catalog.ts: fixed operation catalog, risk classification, readbacks, and parameter hints
• src/router.ts: router selection, sessions, capability checks, and read/write dispatch
• src/plans.ts: immutable expiring write plans, confirmation, attachment hashing, and verification
• src/transport.ts: bounded HTTP transport, cookies, redirects, and response parsing
• src/security.ts: target classification, TLS fingerprint checks, and same-origin validation
• src/adapters/: iUX3 and legacy protocol adapters
• src/config.ts: single-router and multi-router environment configuration
• src/sanitize.ts: recursive secret redaction
• tests/: loopback-only Node test suite

Safety invariants

• Never accept router credentials as MCP tool arguments. Read them only from process environment configuration.
• Never print, return, fixture, or commit real credentials, session cookies, DDNS hostnames, public router URLs, backups, firmware images, or user-specific paths.
• Keep public-address plain HTTP blocked by default. Do not weaken redirect, same-origin, DNS, timeout, or response-size checks.
• Do not expose a direct router-write tool. Every write must pass through an immutable plan and exact user confirmation.
• Do not automatically retry writes after authentication, timeout, transport, or response ambiguity. Reconcile with a readback where possible.
• Classify operations conservatively. Connectivity-affecting, destructive, credential, certificate, restore, reset, reboot, firmware, and storage-format actions must not be downgraded.
• Configuration backups must remain non-overwriting, owner-readable only, size-bounded, and ignored by version control.
• All MCP output must pass through sanitize.