Skip to content

docs: Refactor AGENTS.md to clarify provider architecture and Claude implementation#1566

Open
Ivorisnoob wants to merge 1 commit intopingdotgg:mainfrom
Ivorisnoob:docs/agent
Open

docs: Refactor AGENTS.md to clarify provider architecture and Claude implementation#1566
Ivorisnoob wants to merge 1 commit intopingdotgg:mainfrom
Ivorisnoob:docs/agent

Conversation

@Ivorisnoob
Copy link
Copy Markdown
Contributor

@Ivorisnoob Ivorisnoob commented Mar 30, 2026

What Changed

  • Updated AGENTS.md to accurately reflect that both Codex and Claude providers are fully implemented
  • Added apps/desktop package role description for Electron shell and t3 backend
  • Restructured provider documentation with dedicated sections for Codex and Claude
  • Documented low-level (codexAppServerManager.ts) and high-level (CodexAdapter.ts) layers for Codex
  • Added Claude provider implementation details and adapter location
  • Explained unified provider workflow from WebSocket requests through event projection
  • Clarified how adapters delegate to respective agent runtimes and emit canonical events
  • Fixed test command reference (bun test instead of incorrect "NEVER run bun test")
  • Removed outdated reference to non-existent providerManager.ts

Why

The previous documentation was misleading:

  • It suggested Claude was only "reserved" in contracts/UI, when it's actually fully implemented
  • It didn't explain the provider architecture layers clearly
  • It was missing the desktop package role
  • The test command instruction was incorrect

This refactoring improves clarity for maintainers and contributors about how providers work in the codebase.

Checklist

  • This PR is small and focused
  • I explained what changed and why
  • No UI changes (documentation only)

Note

Low Risk
Documentation-only updates that don’t change runtime behavior; risk is limited to potential confusion if descriptions drift from implementation.

Overview
Refactors AGENTS.md to describe the multi-provider architecture (Codex and Claude) with clearer layering (manager vs adapter) and the end-to-end request/event flow from wsServer.ts through ProviderService, reactors, and ServerPushBus.

Updates package role descriptions (including apps/desktop) and removes/avoids outdated references (e.g., providerManager.ts).

Written by Cursor Bugbot for commit 9d88de8. This will update automatically on new commits. Configure here.

Note

Refactor AGENTS.md to document provider architecture and Claude implementation

Updates AGENTS.md to replace the narrow 'Codex App Server' section with a broader 'Provider Architecture' section covering both providers.

  • Documents the Codex provider (provider: "codex") with its low-level manager and high-level adapter, and the Claude provider (provider: "claudeAgent") as an adapter over the Claude Agent SDK, both managed by ProviderService.
  • Adds a 'How Providers Work' subsection describing the full request lifecycle: routing to ProviderService, adapter delegation, event emission, ingestion/reactors pipeline, persistence/projection, and ServerPushBus updates.
  • Adds an apps/desktop package entry describing the Electron shell and desktop-scoped backend process.

Macroscope summarized 9d88de8.

- Update server package description to mention Claude Agent SDK alongside Codex
- Add desktop package role description for Electron shell and t3 backend
- Restructure provider documentation with dedicated sections for Codex and Claude
- Document low-level and high-level layers for Codex provider integration
- Add Claude provider implementation details and adapter location
- Explain unified provider workflow from WebSocket requests through event projection
- Clarify how adapters delegate to respective agent runtimes and emit canonical events
- Improve clarity on provider architecture for future maintainability
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6201cab3-cde2-4db3-89a8-4e69472f9703

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@github-actions github-actions bot added size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list. labels Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant