Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.62 KB

File metadata and controls

35 lines (26 loc) · 1.62 KB

API and Protocol Surfaces

This file is the index for external interfaces and protocol contracts exposed by this repository.

Domain reference

Document Covers
dialog-policy.md Startup/steady-state Unity modal auto-dismiss, UNITY_OPEN_MCP_DIALOG_POLICY, and related env vars.
api/bridge-http.md Unity bridge HTTP endpoints (/ping, /tools/*, /resources*), envelopes, and errors.
api/mcp-tools.md MCP tool-family overview, example prompts, and focused-reference index.
api/tool-groups.md Session defaults, group activation, compiled availability, and auto-activation.
api/routing-lifecycle.md Live/batch/offline/local routing, lifecycle recovery, offline coverage, and errors.
api/cli-automation.md CLI command and automation reference; links to canonical CI behavior.
api/resources.md MCP resource URIs, payload shapes, and resource router behavior.

Contract boundaries

  • Bridge HTTP contract source: packages/bridge/Editor/Bridge/BridgeHttpServer.cs
  • MCP server routing/registry source: mcp-server/src/index.ts, mcp-server/src/tool-router.ts
  • MCP tool definitions source: mcp-server/src/tools/
  • MCP resources source: mcp-server/src/resources/index.ts, mcp-server/src/resource-router.ts

Contract documentation guidance

  • Prefer documenting behavior and payload shapes over implementation details.
  • Call out breaking changes explicitly.
  • Keep examples minimal and representative.

Update triggers

Update this index when:

  • a new API/protocol doc is added,
  • contract ownership moves to new modules,
  • endpoint or resource domains are reorganized.