Skip to content

fix(agents): document read-only constraint in researcher agent#180

Merged
maystudios merged 1 commit intomainfrom
worktree-agent-ad90f726
Mar 25, 2026
Merged

fix(agents): document read-only constraint in researcher agent#180
maystudios merged 1 commit intomainfrom
worktree-agent-ad90f726

Conversation

@maystudios
Copy link
Copy Markdown
Owner

Summary

  • Adds a ## Constraints section to templates/agents/researcher.md explicitly documenting that the researcher agent operates in read-only mode (no Write or Edit tools).
  • Clarifies that findings are returned via the handoff contract, not written to disk.
  • Notes that GitHub writes go through Bash with gh CLI commands.

Test plan

  • Unit tests pass (540/540)
  • Change is markdown-only in an agent template; no runtime behavior affected

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 25, 2026 17:23
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds explicit documentation to the researcher agent template clarifying its read-only constraints and how outputs should be returned to the orchestrator-driven workflow.

Changes:

  • Adds a new Constraints section describing the researcher as read-only (no Write/Edit tools).
  • States that researcher outputs are returned via the handoff contract rather than written to disk.
  • Mentions how GitHub writes are performed (via Bash + gh).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Constraints

- **Read-only operation** — You do NOT have Write or Edit tools. You cannot create or modify files.
- All findings are returned to the coordinator via the handoff contract, not written to disk.
Copy link

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line says findings are returned to the "coordinator", but the rest of this template (and other agent templates/AGENTS.md) consistently refer to the "orchestrator" as the mediator of handoffs. Please use the same term here to avoid confusion about who receives the handoff output.

Suggested change
- All findings are returned to the coordinator via the handoff contract, not written to disk.
- All findings are returned to the orchestrator via the handoff contract, not written to disk.

Copilot uses AI. Check for mistakes.

- **Read-only operation** — You do NOT have Write or Edit tools. You cannot create or modify files.
- All findings are returned to the coordinator via the handoff contract, not written to disk.
- GitHub writes (issue comments, labels, etc.) go through `Bash` with `gh` CLI commands, not through file writes.
Copy link

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The constraints section says GitHub writes go through Bash/gh, but in this repo the orchestrator is documented as the component that posts agent outputs to GitHub after parsing the handoff contract (see templates/agents/AGENTS.md). In this researcher-specific constraints section, consider clarifying that the researcher should return findings via the handoff contract and let the orchestrator handle GitHub posting, rather than implying the researcher should perform GitHub writes directly.

Suggested change
- GitHub writes (issue comments, labels, etc.) go through `Bash` with `gh` CLI commands, not through file writes.
- You do not perform GitHub writes yourself. Instead, you return findings via the handoff contract, and the orchestrator handles any GitHub updates (e.g., via `Bash` with `gh` CLI commands), not through file writes.

Copilot uses AI. Check for mistakes.
@maystudios maystudios merged commit de3fa43 into main Mar 25, 2026
5 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 5.13.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants