[GH-ISSUE #3040] [Feature] Support WorkBuddy (and WorkBuddy AI) as a setup client

bsakaguchi commented

2026-10-15 18:30:46 +00:00

Owner

Originally created by @cainiao1992 on GitHub (Oct 13, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/3040

Before submitting

I searched the open and closed issues and pull requests for a related proposal.
I understand the contribution scope must be reviewed before integration; open questions are welcome here.
This request does not include credentials, private samples, or sensitive target data.

Area

MCP or agent integration

Current limitation

WorkBuddy (the desktop AI agent from Tencent's CodeBuddy team) and WorkBuddy AI are not among REA's supported setup clients. WorkBuddy users must hand-edit the global ~/.workbuddy/mcp.json to add the rea MCP entry and copy the skill manually, so rea setup, rea doctor, and rea uninstall cannot manage the registration. This was also requested in a comment on #2490.

Use cases

Run rea setup --client workbuddy (or plain rea setup with ~/.workbuddy present) and get the rea MCP server plus the bundled skill installed for WorkBuddy.
Have rea doctor report and rea uninstall remove the WorkBuddy registration like any other supported agent.

Desired outcome and success criteria

rea setup --client workbuddy writes mcpServers.rea into the global ~/.workbuddy/mcp.json (standard mcpServers JSON, stdio transport), preserving existing servers and top-level keys, and installs the bundled skill under ~/.workbuddy/skills. WorkBuddy AI shares this configuration file, so a single client covers both names. The documentation lists WorkBuddy in the supported-agents table.

Expected interaction with targets

No target interaction (documentation or usability only)

Target and scope details (optional)

Setup only writes the user's local WorkBuddy configuration file when the user opts in; no analysis provider or target-facing behavior changes.

Verification available so far

I have a prototype or observed results

Verification details (optional)

A working branch adds a workbuddy entry to SUPPORTED_CLIENT_DEFINITIONS with boundary tests for path resolution, upsert preserving unrelated entries, registration into existing/empty configs, and uninstall removing only rea. Targeted tests, doc-fact checks, and the generated product-catalog consistency check pass locally; setup --client workbuddy --yes was exercised end-to-end in an isolated HOME and produced the expected mcp.json and skill directory. Loading inside the real WorkBuddy client is not yet verified.

Alternatives considered

Hand-editing ~/.workbuddy/mcp.json (the current workaround) — it leaves setup/doctor/uninstall unaware of the client and loses refresh and cleanup.

Possible direction

Add workbuddy to SUPPORTED_CLIENT_DEFINITIONS: configPath: [".workbuddy", "mcp.json"], markerPath: [".workbuddy"], skillPath: [".workbuddy", "skills"], format: "json". The --client allowlist, detection, registration, uninstall, and the generated product catalog all derive from this array, so no other CLI changes are needed.

References

Official WorkBuddy MCP guide (user-level ~/.workbuddy/mcp.json, standard mcpServers JSON): https://www.workbuddy.cn/docs/workbuddy/From-Beginner-to-Expert-Guide/Function-Description/MCP-Guide
Personal skills directory ~/.workbuddy/skills (%userprofile%\.workbuddy\skills on Windows), per WorkBuddy skill authoring guides.

Originally created by @cainiao1992 on GitHub (Oct 13, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/3040 ### Before submitting - [x] I searched the open and closed issues and pull requests for a related proposal. - [x] I understand the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope) must be reviewed before integration; open questions are welcome here. - [x] This request does not include credentials, private samples, or sensitive target data. ### Area MCP or agent integration ### Current limitation WorkBuddy (the desktop AI agent from Tencent's CodeBuddy team) and WorkBuddy AI are not among REA's supported setup clients. WorkBuddy users must hand-edit the global `~/.workbuddy/mcp.json` to add the `rea` MCP entry and copy the skill manually, so `rea setup`, `rea doctor`, and `rea uninstall` cannot manage the registration. This was also requested in a comment on #2490. ### Use cases - Run `rea setup --client workbuddy` (or plain `rea setup` with `~/.workbuddy` present) and get the `rea` MCP server plus the bundled skill installed for WorkBuddy. - Have `rea doctor` report and `rea uninstall` remove the WorkBuddy registration like any other supported agent. ### Desired outcome and success criteria `rea setup --client workbuddy` writes `mcpServers.rea` into the global `~/.workbuddy/mcp.json` (standard `mcpServers` JSON, stdio transport), preserving existing servers and top-level keys, and installs the bundled skill under `~/.workbuddy/skills`. WorkBuddy AI shares this configuration file, so a single client covers both names. The documentation lists WorkBuddy in the supported-agents table. ### Expected interaction with targets - No target interaction (documentation or usability only) ### Target and scope details (optional) Setup only writes the user's local WorkBuddy configuration file when the user opts in; no analysis provider or target-facing behavior changes. ### Verification available so far I have a prototype or observed results ### Verification details (optional) A working branch adds a `workbuddy` entry to `SUPPORTED_CLIENT_DEFINITIONS` with boundary tests for path resolution, upsert preserving unrelated entries, registration into existing/empty configs, and uninstall removing only `rea`. Targeted tests, doc-fact checks, and the generated product-catalog consistency check pass locally; `setup --client workbuddy --yes` was exercised end-to-end in an isolated HOME and produced the expected `mcp.json` and skill directory. Loading inside the real WorkBuddy client is not yet verified. ### Alternatives considered Hand-editing `~/.workbuddy/mcp.json` (the current workaround) — it leaves setup/doctor/uninstall unaware of the client and loses refresh and cleanup. ### Possible direction Add `workbuddy` to `SUPPORTED_CLIENT_DEFINITIONS`: `configPath: [".workbuddy", "mcp.json"]`, `markerPath: [".workbuddy"]`, `skillPath: [".workbuddy", "skills"]`, `format: "json"`. The `--client` allowlist, detection, registration, uninstall, and the generated product catalog all derive from this array, so no other CLI changes are needed. ### References - Official WorkBuddy MCP guide (user-level `~/.workbuddy/mcp.json`, standard `mcpServers` JSON): https://www.workbuddy.cn/docs/workbuddy/From-Beginner-to-Expert-Guide/Function-Description/MCP-Guide - Personal skills directory `~/.workbuddy/skills` (`%userprofile%\.workbuddy\skills` on Windows), per WorkBuddy skill authoring guides.

bsakaguchi