Scripting Guide
Platform Docs API
Machine-readable scripting guide for AI agents
Platform Docs API
The platform scripting guide is available as a public API endpoint that AI agents can call before writing or modifying integrations:
curl https://app.headlessops.ai/api/platform-docsAuth: None required | MCP Scope: mcp:tools
Response: { "docs": "<Markdown scripting guide>" }
The guide contains:
integration.yamlfull schema- TypeScript step API (
ctx.log,ctx.credentials,ctx.http,ctx.stores,ctx.output) - Trigger types reference
- Template expression syntax (
${{ }}) - Example code snippets
- Best practices for idempotency, error handling, and pagination
AI agents connected via MCP automatically receive this guide as context before writing any integration code.