8000 docs: list 26 supported agent harnesses (#1991) by AK-Lmn · Pull Request #2109 · xerj-org/xerj · GitHub
[go: up one dir, main page]
Skip to content

docs: list 26 supported agent harnesses (#1991) - #2109

Merged
xerj-org merged 2 commits into
xerj-org:mainfrom
AK-Lmn:docs/supported-agents-1991
Oct 21, 2026
Merged

docs: list 26 supported agent harnesses (#1991)#2109
xerj-org merged 2 commits into
xerj-org:mainfrom
AK-Lmn:docs/supported-agents-1991

Conversation

@AK-Lmn
@AK-Lmn AK-Lmn commented Oct 21, 2026 •
edited
Loading
Copy link
Copy Markdown
Contributor

Closes #1991

What this changes, and why

The README's "Connect an agent over MCP" section showed one mcpServers block, and xerj init
writes configs for three clients and prints setup lines for three more. Comparable tools publish a
table of 20 or more, and readers use that list to decide whether a tool fits their setup, so the gap
was documentation rather than code.

This adds a Supported agents section to the README with one row per client - config file, config
key, the gotcha that trips people up, and a tested or untested mark - plus the ten non-JSON
shapes as snippets (Codex and Grok CLI TOML, OpenCode and Kilo command arrays, Continue and Goose
YAML, Amp, VS Code/Copilot, Zed, OpenClaw, DeepSeek Harness). The docs CLI page gets the same 26-row
list under a new "Supported agents" heading, and points at the README for the snippets.

Three candidates from the issue are deliberately absent, with the reason stated in the section:
Aider has no MCP client support at all (Aider-AI/aider#3314 is still open), T3 Code hosts an MCP
endpoint that other agents connect to rather than consuming one, and Grok Bot has no documented
local stdio registration. Grok's CLI does, so it gets its own row.

Evidence

The xerj side of the matrix, on Windows against the published v1.0.0-rc.97 x86_64 zip:

PS> xerj.exe mcp (stdin)
{"jsonrpc":"2.0","id":1,"result":{"protocolVersion":"2025-06-18","capabilities":{"tools":{"listChanged":false}},"serverInfo":{"name":"xerj-mcp","version":"1.0.0-rc.97"},...
{"jsonrpc":"2.0","id":2,"result":{"tools":[{"name":"xerj_search",...

One row was run end to end, OpenCode v2.1.2 on Windows:

PS> opencode mcp add xerj --env XERJ_URL=http://localhost:9200 -- C:\...\xerj.exe mcp
MCP server "xerj" added to ...\mcp-test\opencode.json
PS> opencode mcp list
xerj  connected

That run also corrected the shape the docs describe: OpenCode v2 wants mcp.servers.xerj with
type: "local", one command array, and environment (not env), and it only reads the project
file inside a project root, which is what the row now says.

Checks

  • cargo fmt --all - not applicable, no Rust touched
  • Scoped release build - not applicable, no Rust touched
  • cargo test - not applicable, no Rust touched
  • ES-YAML conformance suite - not applicable, docs/landing-only change
  • New ES-compatible behaviour has a matching YAML case - not applicable, no behaviour
  • Docs updated if user-visible behaviour changed - this PR is the documentation
  • Audit in docs/CONTRIBUTION_REVIEW.md - not applicable, not a non-trivial code change
  • Operational audit - N/A, no operational document or runnable recipe changed

Not run: cargo build, cargo test, cargo fmt and the ES-YAML suite, because the diff is
two documentation files.

Provenance

  • Written by: AI agent (OpenCode), run by @AK-Lmn.
  • Verified (commands run, output observed): xerj mcp v1.0.0-rc.97 answered initialize and
    tools/list over stdio on Windows; opencode mcp add wrote the project config and
    opencode mcp list reported xerj connected (OpenCode v2.1.2). The README table renders 26 data
    rows and the docs page list has 26 lines.
  • Assumed (not tested, and what would falsify it): the 25 rows marked untested. Their paths and
    keys come from each client's own documentation as of 2026-10-22, and no client was run. Trying any
    row and finding the file absent or the key ignored falsifies that row. Two have less direct support
    than the rest: Cursor's page was read through search-indexed copies because the site blocked direct
    fetch here, and Claude Desktop's per-OS paths come from the MCP project docs and VS Code's
    discovery table because Anthropic's current page no longer prints them.

@AK-Lmn
docs(readme): list 26 supported agent harnesses (xerj-org#1991)
5ebcc3a 
Motivation: xerj init writes configs for three clients and prints setup lines for three more, while comparable tools publish a table of 20 or more, and readers use that list to decide whether a tool fits their setup. The gap is documentation, not code.

What changed: a Supported agents section in the README, one row per client with its config file, config key, a note and a tested mark, the non-JSON shapes as snippets, and the same 26-row list on the docs CLI page.

Verification: xerj v1.0.0-rc.97 on Windows answered initialize and tools/list over stdio, and OpenCode 2.1.2 registered the binary and reported connected after opencode mcp add wrote the project config. The other 25 rows are transcribed from each client's own documentation and are marked untested. Aider, T3 Code and Grok Bot are listed as excluded, with the reason.
Signed-off-by: kclamano <klamano23@gmail.com>
@cla-bot
cla-bot Bot commented Oct 21, 2026
Copy link
Copy Markdown
8000

Thanks for this contribution — we'd like to merge it.

Before we can, we need a signed Contributor License Agreement from: @AK-Lmn

It is a one-time thing per contributor, not per pull request. Read CLA.md, then open a small pull request adding your GitHub username to .contributors — that pull request is your signature, since it is made from your own account.

Once it is merged, comment @cla-bot check here and this check will go green. If you believe you are already covered, comment @cla-bot check and it will re-verify.

@AK-Lmn AK-Lmn mentioned this pull request Oct 21, 2026
Merged
8 tasks done
@xerj-org
xerj-org commented Oct 21, 2026
Copy link
Copy Markdown
Owner

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Oct 21, 2026
@cla-bot
cla-bot Bot commented Oct 21, 2026
Copy link
Copy Markdown

Re-checking the CLA status for every commit author on this pull request…

Xerj Merger
docs: don't pin the MCP tool count in the supported-agents text
88b66ea 
main serves eighteen tools now and xerj-org#2102 adds a nineteenth; the tested
row is about the client registering the server, not the count.
@cla-bot
cla-bot Bot commented Oct 21, 2026
Copy link
Copy Markdown

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Xerj Merger.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email email@example.com
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

@cla-bot cla-bot Bot removed the cla-signed label Oct 21, 2026
@xerj-org
xerj-org commented Oct 21, 2026
Copy link
Copy Markdown
Owner

Xerj Merger made the fix: reviewed the supported-agents table and snippets. They're docs only (README plus landing/docs/cli.html, no workflow changes), and it's good that every untested row is marked as such. I pushed one fix, 88b66ea: the OpenCode tested note said tools/list answered with "all seventeen tools", but main serves eighteen now (#2085) and the budget PR adds a nineteenth, so the sentence now says "its full tool list" and won't go stale. Your authorship is kept on the squash. Squash-merging. Thanks!

@xerj-org
xerj-org merged commit 4f03909 into xerj-org:main Oct 21, 2026
7 of 9 checks passed
@xerj-org xerj-org mentioned this pull request Oct 21, 2026
Merged
4 of 8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: list 23+ supported agent harnesses (Supported agents table)

2 participants

@AK-Lmn @xerj-org
0