-
Notifications
You must be signed in to change notification settings - Fork 83
feat(tools): add HugeGraph AI DeepWiki assistant #355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
f57ac8e
9d87089
8abb0b6
3a3e8e6
8305e3d
f08b6c1
ede5007
afa4643
91627ee
8b0507e
29aae41
700c783
ad797fd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "interface": { | ||
| "displayName": "HugeGraph AI Repository Assistant" | ||
| }, | ||
| "plugins": [ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "source": { | ||
| "source": "local", | ||
| "path": "./plugins/hugegraph-ai-deepwiki-skill" | ||
| }, | ||
| "policy": { | ||
| "installation": "AVAILABLE", | ||
| "authentication": "ON_INSTALL" | ||
| }, | ||
| "category": "Developer Tools" | ||
| } | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "description": "Repository knowledge assistant for Apache HugeGraph AI.", | ||
| "owner": { | ||
| "name": "HugeGraph Community" | ||
| }, | ||
| "plugins": [ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "source": "./plugins/hugegraph-ai-deepwiki-skill", | ||
| "description": "Ask repository-grounded questions about Apache HugeGraph AI." | ||
| } | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # HugeGraph AI 仓库知识助手 | ||
|
|
||
| [English](README.md) | [中文](README-zh.md) | ||
|
|
||
| 这个独立模块将 [Apache HugeGraph AI](https://github.com/apache/hugegraph-ai) 源码仓库问答能力打包为 Claude Code 和 Codex 可安装的 skill。 | ||
|
|
||
| DeepWiki 是底层线上知识库和 MCP 传输通道: | ||
|
|
||
| ```text | ||
| https://deepwiki.com/apache/hugegraph-ai | ||
| https://mcp.deepwiki.com/mcp | ||
| ``` | ||
|
|
||
| ## 功能 | ||
|
|
||
| - 回答 HugeGraph AI 模块、agent、RAG 工作流、图增强 AI、模型集成、配置、示例、安装和实现细节相关问题。 | ||
| - 使用 `read_wiki_contents` 构建本地 DeepWiki wiki 缓存,并优先搜索缓存。 | ||
| - 当缓存内容不能直接、精准回答问题时,使用 `ask_question` 获取线上答案。 | ||
| - 普通问答不会 clone 上游源码仓库。 | ||
|
|
||
| ## 前置要求 | ||
|
|
||
| - Python 3.10 或更高版本,用于运行随附的 MCP 客户端脚本。 | ||
| - 当前环境需要能访问 `https://mcp.deepwiki.com/mcp`。 | ||
|
Comment on lines
+21
to
+24
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in ad797fd. The Chinese README now states Python 3.10+ for the bundled MCP client, matching this repository runtime requirement. |
||
|
|
||
| ## 目录结构 | ||
|
|
||
| ```text | ||
| tools/ai/hugegraph-ai-deepwiki-skill/ | ||
| ├── README.md | ||
| ├── README-zh.md | ||
| ├── .agents/plugins/marketplace.json | ||
| ├── .claude-plugin/marketplace.json | ||
| └── plugins/hugegraph-ai-deepwiki-skill/ | ||
| ├── .claude-plugin/plugin.json | ||
| ├── .codex-plugin/plugin.json | ||
| └── skills/hugegraph-ai-deepwiki-skill/ | ||
| ├── SKILL.md | ||
| ├── agents/openai.yaml | ||
| ├── references/repos.json | ||
| └── scripts/deepwiki_mcp.py | ||
| ``` | ||
|
|
||
| ## Claude Code 安装 | ||
|
|
||
| 从当前仓库安装: | ||
|
|
||
| ```bash | ||
| cd tools/ai/hugegraph-ai-deepwiki-skill | ||
| claude plugin marketplace add "$(pwd)" | ||
| claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| 从已发布分支安装时,先 clone 仓库,再从本地模块路径安装: | ||
|
|
||
| ```bash | ||
| git clone -b <branch> https://github.com/<owner>/hugegraph-ai.git | ||
| cd hugegraph-ai/tools/ai/hugegraph-ai-deepwiki-skill | ||
| claude plugin marketplace add "$(pwd)" | ||
| claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| 手动安装用户级 skill: | ||
|
|
||
| ```bash | ||
| mkdir -p ~/.claude/skills | ||
| cp -R plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill ~/.claude/skills/ | ||
| ``` | ||
|
|
||
| ### 让 Claude Code 自动安装 | ||
|
|
||
| 在 HugeGraph AI 仓库根目录的 Claude Code 里粘贴: | ||
|
|
||
| ```text | ||
| 请从当前 checkout 安装 HugeGraph AI 仓库知识助手。进入 `tools/ai/hugegraph-ai-deepwiki-skill`,运行 `claude plugin marketplace add "$(pwd)"`,然后运行 `claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill`。不要硬编码绝对路径。 | ||
| ``` | ||
|
|
||
| ## Codex 安装 | ||
|
|
||
| 从当前仓库安装: | ||
|
|
||
| ```bash | ||
| cd tools/ai/hugegraph-ai-deepwiki-skill | ||
| codex plugin marketplace add "$(pwd)" | ||
| codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| 从已发布分支安装时,先 clone 仓库,再从本地模块路径安装: | ||
|
|
||
| ```bash | ||
| git clone -b <branch> https://github.com/<owner>/hugegraph-ai.git | ||
| cd hugegraph-ai/tools/ai/hugegraph-ai-deepwiki-skill | ||
| codex plugin marketplace add "$(pwd)" | ||
| codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| 如果当前 Codex 版本不能直接安装 plugin,可以安装 raw skill: | ||
|
|
||
| ```bash | ||
| CODEX_HOME="${CODEX_HOME:-$HOME/.codex}" | ||
| mkdir -p "$CODEX_HOME/skills" | ||
| cp -R plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill "$CODEX_HOME/skills/" | ||
| ``` | ||
|
|
||
| ### 让 Codex 自动安装 | ||
|
|
||
| 在 HugeGraph AI 仓库根目录的 Codex 里粘贴: | ||
|
|
||
| ```text | ||
| 请从当前 checkout 安装 HugeGraph AI 仓库知识助手。进入 `tools/ai/hugegraph-ai-deepwiki-skill`,运行 `codex plugin marketplace add "$(pwd)"`,然后运行 `codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill`。如果当前 Codex 构建没有 plugin add 命令,就把 `plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill` 复制到 `${CODEX_HOME:-$HOME/.codex}/skills`。不要硬编码绝对路径。 | ||
| ``` | ||
|
|
||
| ## 使用方式 | ||
|
|
||
| 安装后,可以在提问时显式指定: | ||
|
|
||
| ```text | ||
| 使用 $hugegraph-ai-deepwiki-skill 解释 HugeGraph AI 的 RAG 工作流。 | ||
| ``` | ||
|
|
||
| Apache HugeGraph 图数据库相关问题请安装 `apache/hugegraph` 仓库中的独立 HugeGraph 仓库知识助手。 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # HugeGraph AI Repository Assistant | ||
|
|
||
| [中文](README-zh.md) | [English](README.md) | ||
|
|
||
| This standalone module packages a Claude Code and Codex skill for answering questions about the [Apache HugeGraph AI](https://github.com/apache/hugegraph-ai) source repository. | ||
|
|
||
| DeepWiki is used as the online knowledge and MCP transport layer: | ||
|
|
||
| ```text | ||
| https://deepwiki.com/apache/hugegraph-ai | ||
| https://mcp.deepwiki.com/mcp | ||
| ``` | ||
|
|
||
| ## What It Does | ||
|
|
||
| - Answers repository-grounded questions about HugeGraph AI modules, agents, RAG workflows, graph-enhanced AI features, model integration, configuration, examples, installation, and implementation details. | ||
| - Uses `read_wiki_contents` to build a local DeepWiki wiki cache and searches that cache before answering. | ||
| - Uses `ask_question` when the cached context does not directly and precisely answer the question. | ||
| - Avoids cloning upstream repositories for ordinary Q&A. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Python 3.10 or later for the bundled MCP client script. | ||
| - Network access to `https://mcp.deepwiki.com/mcp`. | ||
|
Comment on lines
+21
to
+24
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in ad797fd. The English README now states Python 3.10+ for the bundled MCP client, matching the repository |
||
|
|
||
| ## Layout | ||
|
|
||
| ```text | ||
| tools/ai/hugegraph-ai-deepwiki-skill/ | ||
| ├── README.md | ||
| ├── README-zh.md | ||
| ├── .agents/plugins/marketplace.json | ||
| ├── .claude-plugin/marketplace.json | ||
| └── plugins/hugegraph-ai-deepwiki-skill/ | ||
| ├── .claude-plugin/plugin.json | ||
| ├── .codex-plugin/plugin.json | ||
| └── skills/hugegraph-ai-deepwiki-skill/ | ||
| ├── SKILL.md | ||
| ├── agents/openai.yaml | ||
| ├── references/repos.json | ||
| └── scripts/deepwiki_mcp.py | ||
| ``` | ||
|
|
||
| ## Claude Code Install | ||
|
|
||
| From this repository: | ||
|
|
||
| ```bash | ||
| cd tools/ai/hugegraph-ai-deepwiki-skill | ||
| claude plugin marketplace add "$(pwd)" | ||
| claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| From a published branch, clone the repository first and install from the local module path: | ||
|
|
||
| ```bash | ||
| git clone -b <branch> https://github.com/<owner>/hugegraph-ai.git | ||
| cd hugegraph-ai/tools/ai/hugegraph-ai-deepwiki-skill | ||
| claude plugin marketplace add "$(pwd)" | ||
| claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| Manual user-level skill install: | ||
|
|
||
| ```bash | ||
| mkdir -p ~/.claude/skills | ||
| cp -R plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill ~/.claude/skills/ | ||
| ``` | ||
|
|
||
| ### Ask Claude Code To Install It | ||
|
|
||
| Paste this into Claude Code from the HugeGraph AI repository root: | ||
|
|
||
| ```text | ||
| Install the HugeGraph AI repository assistant from this checkout. Enter `tools/ai/hugegraph-ai-deepwiki-skill`, run `claude plugin marketplace add "$(pwd)"`, then run `claude plugin install hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill`. Do not hardcode absolute paths. | ||
| ``` | ||
|
|
||
| ## Codex Install | ||
|
|
||
| From this repository: | ||
|
|
||
| ```bash | ||
| cd tools/ai/hugegraph-ai-deepwiki-skill | ||
| codex plugin marketplace add "$(pwd)" | ||
| codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| From a published branch, clone the repository first and install from the local module path: | ||
|
|
||
| ```bash | ||
| git clone -b <branch> https://github.com/<owner>/hugegraph-ai.git | ||
| cd hugegraph-ai/tools/ai/hugegraph-ai-deepwiki-skill | ||
| codex plugin marketplace add "$(pwd)" | ||
| codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill | ||
| ``` | ||
|
|
||
| If your Codex build cannot install plugins directly, install the raw skill: | ||
|
|
||
| ```bash | ||
| CODEX_HOME="${CODEX_HOME:-$HOME/.codex}" | ||
| mkdir -p "$CODEX_HOME/skills" | ||
| cp -R plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill "$CODEX_HOME/skills/" | ||
| ``` | ||
|
|
||
| ### Ask Codex To Install It | ||
|
|
||
| Paste this into Codex from the HugeGraph AI repository root: | ||
|
|
||
| ```text | ||
| Install the HugeGraph AI repository assistant from this checkout. Enter `tools/ai/hugegraph-ai-deepwiki-skill`, run `codex plugin marketplace add "$(pwd)"`, then run `codex plugin add hugegraph-ai-deepwiki-skill@hugegraph-ai-deepwiki-skill`. If this Codex build has no plugin add command, copy `plugins/hugegraph-ai-deepwiki-skill/skills/hugegraph-ai-deepwiki-skill` into `${CODEX_HOME:-$HOME/.codex}/skills`. Do not hardcode absolute paths. | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| After installation, ask for the skill explicitly when needed: | ||
|
|
||
| ```text | ||
| Use $hugegraph-ai-deepwiki-skill to explain the HugeGraph AI RAG workflow. | ||
| ``` | ||
|
|
||
| For Apache HugeGraph graph database questions, install the separate HugeGraph repository assistant from the `apache/hugegraph` repository instead. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "description": "Repository knowledge assistant for Apache HugeGraph AI.", | ||
| "version": "0.1.4", | ||
| "author": { | ||
| "name": "HugeGraph Community" | ||
| }, | ||
| "homepage": "https://github.com/apache/hugegraph-ai", | ||
| "repository": "https://github.com/apache/hugegraph-ai", | ||
| "license": "Apache-2.0", | ||
| "keywords": ["hugegraph-ai", "deepwiki", "apache", "rag", "knowledge-assistant"], | ||
| "skills": "./skills/" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "name": "hugegraph-ai-deepwiki-skill", | ||
| "version": "0.1.4", | ||
| "description": "Repository knowledge assistant for Apache HugeGraph AI.", | ||
| "author": { | ||
| "name": "HugeGraph Community", | ||
| "email": "", | ||
| "url": "https://github.com/apache/hugegraph-ai" | ||
| }, | ||
| "homepage": "https://github.com/apache/hugegraph-ai", | ||
| "repository": "https://github.com/apache/hugegraph-ai", | ||
| "license": "Apache-2.0", | ||
| "keywords": ["hugegraph-ai", "deepwiki", "apache", "rag", "knowledge-assistant"], | ||
| "skills": "./skills/", | ||
| "interface": { | ||
| "displayName": "HugeGraph AI Repository Assistant", | ||
| "shortDescription": "Ask repository-grounded questions about Apache HugeGraph AI.", | ||
| "longDescription": "Provides an Apache HugeGraph AI repository knowledge assistant for installation, examples, agents, RAG workflows, graph-enhanced AI, model integration, configuration, and implementation questions. DeepWiki MCP is used as the underlying retrieval channel.", | ||
| "developerName": "HugeGraph Community", | ||
| "category": "Developer Tools", | ||
| "capabilities": ["Knowledge", "MCP"], | ||
| "websiteURL": "https://github.com/apache/hugegraph-ai", | ||
| "defaultPrompt": [ | ||
| "Use $hugegraph-ai-deepwiki-skill to answer my HugeGraph AI repository question." | ||
| ], | ||
| "brandColor": "#0F766E" | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partially addressed in ad797fd. I re-tested
git archivewithout these rules and the archive omittedscripts/deepwiki_mcp.pywhile keeping the tests, so the negation rules are required for source/archive installs. I kept them and added a comment explaining that they preserve the DeepWiki skill MCP client in release/source archives.