Yichus / Reference / API MCP tools

api_dossier

The one-shot trace dossier: every binding with its source location, snippet, inferred type, effect class and dependencies. With a focus binding, the dossier narrows to that binding's transitive dependency closure, focus first and breadth-first after -- one call instead of a walk. A focus that names no binding, or an ambiguous bare name, is an error listing the candidates, never a silent whole-program dossier. Same job as yichus dossier, which writes the file; this returns it.

Kind: Dossier. Origin: Yichus/Mcp::catalog.

CLI: yichus dossier — one implementation: both run TraceDossier.resolveFocus then build and render; the CLI writes the file, the tool returns it.

Parameters

• sources (required, array) — JSON array of {fileName, source} Bosatsu files.
• binding (optional, string) — Optional focus: a bare binding name (must be unambiguous) or Pkg/Path/name to pin the package. Omitted, the dossier covers every binding.

Read the result according to this tool’s scope: static checks, bounded execution checks, and descriptive diagrams answer different questions. A successful call is not a general approval of the program. The safety and permissions guide compares the checks and provides editable ownership, guard, and role examples.