Skip to content

docs(api): document reading an automation run's artifact - #149

Merged
charlesrhoward merged 1 commit into
mainfrom
docs/automation-run-artifact
Oct 11, 2026
Merged

charlesrhoward merged 1 commit into
mainfrom
docs/automation-run-artifact

Conversation

@charlesrhoward

@charlesrhoward charlesrhoward commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Mogplex/mogplex#628 added GET /api/v1/mogplex/automations/{automationId}/runs/{runId}/artifact and the matching MCP tool, mogplex_get_automation_run_artifact. An integration that triggers an API automation can now read back the JSON file the run committed under .mogplex/artifacts/, without holding a GitHub credential.

  • API reference: the endpoint index gains the route. A new "Read an automation run artifact" section covers the query, response type and errors. The file is read from the run's own branch at its tip, so pinned is always false, and commitSha names what was read.
  • API triggers guide: a short "Read the output" section after "Follow a run", noting that a key limited to automations can call it.
  • MCP tools: a row for mogplex_get_automation_run_artifact.

The status codes in the error table match the route: 400 bad ids or path, 404 missing, 409 not successful / not API-triggered / GitHub disconnected, 502 GitHub unavailable.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@vercel

vercel Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
mogplex-docs Ready Ready Preview Oct 10, 2026 11:59pm UTC

Request Review

@mogplex

mogplex Bot commented Oct 10, 2026

Copy link
Copy Markdown

Mogplex PR Review

Status: No material issues found

Docs-only PR #149 adds accurate, consistent documentation for the new automation run artifact endpoint across api-triggers.mdx, mcp/tools.mdx, and reference/api.mdx; no issues found.

  • Scope is clean: Only documentation files changed (content/docs/integrations/api-triggers.mdx, content/docs/mcp/tools.mdx, content/docs/reference/api.mdx) to document the new GET artifact endpoint and mogplex_get_automation_run_artifact MCP tool.
  • Content matches description: API reference includes the AutomationRunArtifactQuery and AutomationRunArtifactData types, branch-tip behavior (pinned always false, commitSha names what was read), and the error table (BAD_REQUEST 400, NOT_FOUND 404, CONFLICT 409, SERVICE_UNAVAILABLE 502) matching the PR description.
  • Cross-references are correct: api-triggers.mdx links to the "Read an automation run artifact" reference section; the MCP tools table adds the new read-scoped tool row. Links and wording follow the existing docs style.

View check run

@charlesrhoward
charlesrhoward merged commit 5f9fa50 into main Oct 11, 2026
7 checks passed
@charlesrhoward
charlesrhoward deleted the docs/automation-run-artifact branch October 11, 2026 00:09

This branch was successfully deployed

1 active deployment
Preview — 80f42350 Deployed Oct 10, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant