Skip to content
PtahPtah
Edit this pagePropose a change on GitHubView sourceOpen the source used for this buildReport a documentation issueOpen a prefilled GitHub issue

Extend and integrate

The CLI is one adapter over Ptah’s schema, planning, rendering, and migration packages. Embed only the published Go surface, or expose a constrained command surface to an AI client when a human-reviewed tool boundary is the better fit.

Common tasks

Section titled “Common tasks”
Embed the public Go APIChoose a stable package and verify that it is part of the supported embedder surface.
Reuse a componentCompose parsers, renderers, schema diff, planning, migration files, or execution.
Build SQL with PtahConstruct parameterized queries through the public query-builder package.
Connect an AI client over MCPChoose allowed tools, configure the client, and keep mutation behind explicit policy.
Ask for CLI assistanceGenerate a bounded command suggestion without granting an agent a tool session.

Choose the boundary

Section titled “Choose the boundary”

Use Go packages when your program owns types, control flow, and error handling. Use MCP when an external client needs discoverable tools under a restricted policy. Use AI assist when the desired result is a command suggestion for a human to inspect rather than a callable tool.

Anything under internal/ can change without preserving an import contract. The public API ledger is the authority on supported packages.

Reference

Section titled “Reference”

Native command reference includes the MCP server and tool inventory generated from the current command tree.