Skip to content

docs: describe MCP run inspector link - #27

Merged
yohamta0 merged 3 commits into
mainfrom
agent/mcp-run-inspector-open-link
Aug 1, 2026
Merged

docs: describe MCP run inspector link#27
yohamta0 merged 3 commits into
mainfrom
agent/mcp-run-inspector-open-link

Conversation

@yohamta0

@yohamta0 yohamta0 commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

What changed

  • document the MCP App run inspector controls
  • explain when the Open in Dagu button is available
  • describe how Dagu chooses the Web UI base URL and when to configure public_url

Why

The run inspector can now hand users off to the full Dagu run page through an MCP Apps host. The guide should explain that capability and the reverse-proxy configuration needed for a reachable link.

Validation

  • pnpm build

Summary by cubic

Documented the MCP App Run Inspector (run/step status, scheduler and per-step logs, refresh/stop/retry).
Added step log inspection docs: new step_log target, dagu://runs/{name}/{dagRunId}/steps/{stepName}/logs resource, and audit fields for per-step logs; clarified that dagu://runs/{name}/{dagRunId}/logs includes scheduler and step log metadata; removed prior run-link guidance.

Written for commit 9befe61. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Clarified MCP audit event identifiers for workflow and step logs.
    • Documented the distinction between scheduler/step metadata and per-step stdout/stderr logs.
    • Added guidance for the MCP run inspector, including status, log viewing, refresh, stop, and retry actions.
    • Documented step-level log queries with the step_log target and required step name.

@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1317c224-2d66-47a6-aaaf-5e8399f3cb57

📥 Commits

Reviewing files that changed from the base of the PR and between 34de60f and 9befe61.

📒 Files selected for processing (3)
  • mcp/auditability.md
  • mcp/resources.md
  • mcp/tools.md

📝 Walkthrough

Walkthrough

The MCP documentation now distinguishes scheduler and step logs, documents step-level dagu_read requests, expands audit resource identifiers, and describes the MCP App Run Inspector.

Changes

MCP log documentation

Layer / File(s) Summary
MCP log resources and run inspector
mcp/resources.md
The resource documentation distinguishes scheduler and step logs, defines per-step stdout and stderr resources, and describes run status, log viewing, refresh, stop, and retry actions.
Step log read contract
mcp/tools.md
The dagu_read documentation adds the step_log target, requires stepName, and includes a step log request example.
Audit resource identifiers
mcp/auditability.md
The audit documentation adds dag_run_step_log and documents run-level and step-level log resource identifiers.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • dagucloud/docs#19: Both PRs update the MCP auditability, resources, and tools documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/mcp-run-inspector-open-link

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
dagu-sh-docs 9befe61 Aug 01 2026, 12:31 PM

@yohamta0
yohamta0 marked this pull request as ready for review August 1, 2026 14:43
@yohamta0
yohamta0 merged commit dac9c8e into main Aug 1, 2026
3 of 4 checks passed
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