Skip to content

docs: add bilingual HugeGraph MCP usage guides - #576

Open
imbajin wants to merge 1 commit into
apache:masterfrom
hugegraph:docs/mcp-guide-hugegraph-20261012
Open

imbajin wants to merge 1 commit into
apache:masterfrom
hugegraph:docs/mcp-guide-hugegraph-20261012

Conversation

@imbajin

@imbajin imbajin commented Nov 16, 2026

Copy link
Copy Markdown
Member

Purpose of the PR

Add English and Chinese HugeGraph-MCP usage guides and make them discoverable from the HugeGraph-AI overview and sidebar. Users can install the published package, configure a STDIO client, verify a connection, and understand the supported query/schema/write boundaries and optional AI prerequisites.

The guides distinguish published hugegraph-mcp==1.7.1 behavior from current-source core/legacy toolsets and future aligned releases. They document separate graph/AI connection settings, authentication and write gates, refresh target checks, and why raw Gremlin and other registered operations can remain disabled.

Paired implementation: hugegraph/hugegraph-ai#81. Coordinate the current-source guidance with that code PR; the published-package installation remains explicitly pinned.

This PR independently applies the same five documentation/navigation files to hugegraph/hugegraph-doc:master at 6181c87: 5 files, +461/-0. It carries no changes to the target repository's CI, theme, or site runtime.

Validation

  • Fresh warning-strict scripts/hugo.sh build passed on this target branch (Hugo Extended 0.165.0, Go 1.27.0, repository-pinned OINK 1.2.0).
  • Complete bash dist/validate-links.sh passed in an isolated Linux container using copies of the current content/assets and the unchanged validator with Windows CRLF normalized to LF.
  • Current tests/e2e/search-ranking.spec.js: 24 passed, against this target's fresh artifact in Edge Chromium.
  • English and Chinese pages at 1440 x 1000 and 390 x 844: page heading, overview-to-guide navigation, counterpart-language link, desktop sidebar, desktop MCP search/navigation, and no horizontal overflow passed.
  • git diff --check passed. Before/after images below were regenerated from this target's current base and topic builds.
  • Full Python 3.13 source suite was attempted on Windows: 255 tests, 9 failures, 39 errors, 1 skipped. It is not a passing source-suite run: observed blockers include symlink privileges, POSIX process/script assumptions, missing image tooling and path-separator assertions. Linux CI is still required; no source test was weakened or disabled.

Before / after

View Before After
EN desktop Before After
EN mobile Before After
CN desktop Before After
CN mobile Before After

New guide screenshots and capture details are stored on a separate evidence branch.

Synchronized documentation PR: apache/hugegraph-doc#520, based independently on Apache master to keep both reviews scoped.

Source-suite baseline comparison: the unmodified target master also failed on the same Windows toolchain (255 tests, 9 failures, 38 errors, 1 skipped). The set of failing test identities is identical between base and topic; varying error totals include Windows temporary-directory cleanup/locked-file errors (WinError 32/WinError 5). No new failing test identity was introduced by the five-file documentation patch. This comparison does not replace Linux CI.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants