docs: overhaul agent-integrations section#2217
Merged
ZaynJarvis merged 5 commits intoMay 25, 2026
Merged
Conversation
…iendliness Restructure the agent-integrations documentation (EN + ZH) to be concise, beginner-friendly, and consistently structured across all runtimes.
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Pull request overview
This PR restructures the Agent Integrations documentation (EN/ZH) to be more beginner-friendly by splitting “generic MCP clients” and “community plugins” into dedicated pages, adding a first-class Hermes Agent page, and trimming deep implementation details in favor of linking out to plugin READMEs.
Changes:
- Added new integration pages for Hermes Agent, MCP Clients, LangChain/LangGraph (full ZH rewrite), and Community Plugins (EN/ZH).
- Refactored existing Claude Code / Codex / OpenClaw pages to focus on install → verify → config/troubleshooting, moving deep implementation details out.
- Updated MCP integration guides (EN/ZH) to cross-link to the new MCP Clients quick-setup page and updated the integration overview matrices accordingly.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/guides/06-mcp-integration.md | Adds a prominent link to the new MCP Clients quick-setup page. |
| docs/zh/guides/06-mcp-integration.md | Adds the equivalent quick-setup link in ZH. |
| docs/en/agent-integrations/01-overview.md | Updates the decision matrix and integration-depth taxonomy to reflect new pages. |
| docs/zh/agent-integrations/01-overview.md | ZH version of the updated overview/matrix. |
| docs/en/agent-integrations/02-claude-code.md | Trims and restructures Claude Code plugin doc; adds verification tips and blog link. |
| docs/zh/agent-integrations/02-claude-code.md | ZH version of the Claude Code page restructure and tips. |
| docs/en/agent-integrations/03-openclaw.md | Simplifies OpenClaw instructions; adds upgrade note, collapsible sections, and updated verification flow. |
| docs/zh/agent-integrations/03-openclaw.md | ZH version of the OpenClaw page restructure. |
| docs/en/agent-integrations/04-codex.md | Simplifies Codex plugin instructions; adds collapsible manual setup/config, blog link, and updated troubleshooting. |
| docs/zh/agent-integrations/04-codex.md | ZH version of the Codex page restructure. |
| docs/en/agent-integrations/05-hermes.md | New Hermes Agent integration page. |
| docs/zh/agent-integrations/05-hermes.md | ZH version of the Hermes Agent page. |
| docs/en/agent-integrations/06-mcp-clients.md | New MCP Clients page with config snippets, tool list, and troubleshooting. |
| docs/zh/agent-integrations/06-mcp-clients.md | ZH version of the MCP Clients page. |
| docs/en/agent-integrations/07-langchain-langgraph.md | New condensed LangChain/LangGraph page with quick examples and pointers to runnable samples. |
| docs/zh/agent-integrations/07-langchain-langgraph.md | New full ZH LangChain/LangGraph page matching EN depth. |
| docs/en/agent-integrations/08-community-plugins.md | New Community Plugins page (AstrBot + OpenCode). |
| docs/zh/agent-integrations/08-community-plugins.md | ZH version of the Community Plugins page. |
| docs/en/agent-integrations/05-other-plugins.md | Removed/superseded by MCP Clients + Community Plugins split. |
| docs/zh/agent-integrations/05-other-plugins.md | Removed/superseded by MCP Clients + Community Plugins split. |
| docs/en/agent-integrations/06-langchain-langgraph.md | Removed/superseded by the new 07-langchain-langgraph.md. |
| docs/zh/agent-integrations/06-langchain-langgraph.md | Removed/superseded by the new 07-langchain-langgraph.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
| ``` | ||
|
|
||
| No authentication is needed when connecting to a local server on `localhost`. |
Comment on lines
+40
to
+48
| ### Trae / Cursor / ChatGPT / Codex / OpenCode | ||
|
|
||
| Standard `mcpServers` config as shown above — all verified with API key auth. | ||
|
|
||
| ### Claude Desktop / Claude.ai (OAuth) | ||
|
|
||
| These clients require OAuth 2.1 — API keys cannot be passed directly. OpenViking ships a native OAuth 2.1 implementation, so no external proxy is needed. | ||
|
|
||
| If you already have HTTPS configured for your OpenViking server, just connect to `https://your-server.com/mcp` — the client will walk you through the OAuth authorization flow automatically. |
Comment on lines
+50
to
+58
| ```python | ||
| from langchain_core.runnables import RunnableLambda | ||
| from openviking.integrations.langchain import with_openviking_context | ||
|
|
||
| chain = with_openviking_context( | ||
| RunnableLambda(lambda msgs: AIMessage(content="...")), | ||
| url="http://localhost:1933", | ||
| api_key="...", | ||
| ) |
| } | ||
| ``` | ||
|
|
||
| 连接 `localhost` 本地服务时无需认证。 |
Comment on lines
+40
to
+49
| ### Trae / Cursor / ChatGPT / Codex / OpenCode | ||
|
|
||
| 使用上面的标准 `mcpServers` 配置即可——均已通过 API Key 鉴权验证。 | ||
|
|
||
| ### Claude Desktop / Claude.ai (OAuth) | ||
|
|
||
| 这些客户端要求 OAuth 2.1——无法直接传 API Key。OpenViking 自带原生 OAuth 2.1 实现，无需外部代理。 | ||
|
|
||
| 如果你已经为 OpenViking 服务配好了 HTTPS，直接连接 `https://your-server.com/mcp` 端点即可——客户端会自动引导你完成 OAuth 授权流程。 | ||
|
|
Comment on lines
+50
to
+58
| ```python | ||
| from langchain_core.runnables import RunnableLambda | ||
| from openviking.integrations.langchain import with_openviking_context | ||
|
|
||
| chain = with_openviking_context( | ||
| RunnableLambda(lambda msgs: AIMessage(content="...")), | ||
| url="http://localhost:1933", | ||
| api_key="...", | ||
| ) |
Collaborator
Author
|
Addressed review comments:
|
r266-tech
added a commit
to r266-tech/OpenViking
that referenced
this pull request
May 26, 2026
r266-tech
added a commit
to r266-tech/OpenViking
that referenced
this pull request
May 26, 2026
qin-ctx
pushed a commit
that referenced
this pull request
May 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Major restructure of the
docs/<en,zh>/agent-integrations/section for clarity and beginner-friendliness.Related Issue
N/A
Type of Change
Changes Made
05-hermes.md) — promoted from community-plugins to its own page withhermes memory setupinstructions06-mcp-clients.md) — extracted client-facing setup fromguides/06-mcp-integration.md; covers all verified platforms (Trae, Cursor, ChatGPT, Codex, OpenCode, Claude Desktop)05-other-plugins.md→06-mcp-clients.md+08-community-plugins.md/pluginsand/openviking-memory:ovverify tips to Claude Code pagesguides/06-mcp-integration.mdto the new MCP clients pageBefore: 6 files × 2 langs, ~860 EN lines, ~675 ZH lines (LangChain stub)
After: 8 files × 2 langs, ~580 EN lines, ~580 ZH lines (full parity)
Testing
docs:buildpasses with no errorsChecklist
Additional Notes
Each page now follows a beginner-friendly pattern: value proposition → one-command install → verify → collapsed config/troubleshooting. Detailed implementation info links back to plugin READMEs.