Skip to content
Open
20 changes: 20 additions & 0 deletions tools/ai/hugegraph-deepwiki-skill/.agents/plugins/marketplace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "hugegraph-deepwiki-skill",
"interface": {
"displayName": "HugeGraph Repository Assistant"
},
"plugins": [
{
"name": "hugegraph-deepwiki-skill",
"source": {
"source": "local",
"path": "./plugins/hugegraph-deepwiki-skill"
},
"policy": {
"installation": "AVAILABLE",
"authentication": "ON_INSTALL"
},
"category": "Developer Tools"
}
]
}
14 changes: 14 additions & 0 deletions tools/ai/hugegraph-deepwiki-skill/.claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "hugegraph-deepwiki-skill",
"description": "Repository knowledge assistant for Apache HugeGraph.",
"owner": {
"name": "HugeGraph Community"
},
"plugins": [
{
"name": "hugegraph-deepwiki-skill",
"source": "./plugins/hugegraph-deepwiki-skill",
"description": "Ask repository-grounded questions about Apache HugeGraph."
}
]
}
121 changes: 121 additions & 0 deletions tools/ai/hugegraph-deepwiki-skill/README-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# HugeGraph 仓库知识助手

[English](README.md) | [中文](README-zh.md)

这个独立模块将 [Apache HugeGraph](https://github.com/apache/hugegraph) 源码仓库问答能力打包为 Claude Code 和 Codex 可安装的 skill。

DeepWiki 是底层线上知识库和 MCP 传输通道:

```text
https://deepwiki.com/apache/hugegraph
https://mcp.deepwiki.com/mcp
```

## 功能

- 回答 HugeGraph 架构、模块、API、存储后端、schema、traversal、配置、构建、测试和实现细节相关问题。
- 使用 `read_wiki_contents` 构建本地 DeepWiki wiki 缓存,并优先搜索缓存。
- 当缓存内容不能直接、精准回答问题时,使用 `ask_question` 获取线上答案。
- 普通问答不会 clone 上游源码仓库。

## 前置要求

- Python 3.9 或更高版本,用于运行随附的 MCP 客户端脚本。
- 当前环境需要能访问 `https://mcp.deepwiki.com/mcp`。

## 目录结构

```text
tools/ai/hugegraph-deepwiki-skill/
├── README.md
├── README-zh.md
├── .agents/plugins/marketplace.json
├── .claude-plugin/marketplace.json
└── plugins/hugegraph-deepwiki-skill/
├── .claude-plugin/plugin.json
├── .codex-plugin/plugin.json
└── skills/hugegraph-deepwiki-skill/
├── SKILL.md
├── agents/openai.yaml
├── references/repos.json
└── scripts/deepwiki_mcp.py
```

## Claude Code 安装

从当前仓库安装:

```bash
cd tools/ai/hugegraph-deepwiki-skill
claude plugin marketplace add "$(pwd)"
claude plugin install hugegraph-deepwiki-skill@hugegraph-deepwiki-skill
```

从已发布分支安装时,先 clone 仓库,再从本地模块路径安装:

```bash
git clone -b <branch> https://github.com/<owner>/hugegraph.git
cd hugegraph/tools/ai/hugegraph-deepwiki-skill
claude plugin marketplace add "$(pwd)"
claude plugin install hugegraph-deepwiki-skill@hugegraph-deepwiki-skill
```

手动安装用户级 skill:

```bash
mkdir -p ~/.claude/skills
cp -R plugins/hugegraph-deepwiki-skill/skills/hugegraph-deepwiki-skill ~/.claude/skills/
```

### 让 Claude Code 自动安装

在 HugeGraph 仓库根目录的 Claude Code 里粘贴:

```text
Install the HugeGraph repository assistant from this checkout. Enter `tools/ai/hugegraph-deepwiki-skill`, run `claude plugin marketplace add "$(pwd)"`, then run `claude plugin install hugegraph-deepwiki-skill@hugegraph-deepwiki-skill`. Do not hardcode absolute paths.
```

## Codex 安装

从当前仓库安装:

```bash
cd tools/ai/hugegraph-deepwiki-skill
codex plugin marketplace add "$(pwd)"
codex plugin add hugegraph-deepwiki-skill@hugegraph-deepwiki-skill
```

从已发布分支安装时,先 clone 仓库,再从本地模块路径安装:

```bash
git clone -b <branch> https://github.com/<owner>/hugegraph.git
cd hugegraph/tools/ai/hugegraph-deepwiki-skill
codex plugin marketplace add "$(pwd)"
codex plugin add hugegraph-deepwiki-skill@hugegraph-deepwiki-skill
```

如果当前 Codex 版本不能直接安装 plugin,可以安装 raw skill:

```bash
CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
mkdir -p "$CODEX_HOME/skills"
cp -R plugins/hugegraph-deepwiki-skill/skills/hugegraph-deepwiki-skill "$CODEX_HOME/skills/"
```

### 让 Codex 自动安装

在 HugeGraph 仓库根目录的 Codex 里粘贴:

```text
Install the HugeGraph repository assistant from this checkout. Enter `tools/ai/hugegraph-deepwiki-skill`, run `codex plugin marketplace add "$(pwd)"`, then run `codex plugin add hugegraph-deepwiki-skill@hugegraph-deepwiki-skill`. If this Codex build has no plugin add command, copy `plugins/hugegraph-deepwiki-skill/skills/hugegraph-deepwiki-skill` into `${CODEX_HOME:-$HOME/.codex}/skills`. Do not hardcode absolute paths.
```

## 使用方式

安装后,可以在提问时显式指定:

```text
Comment on lines +113 to +117
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已修复。最新 deepwiki-skill 分支的 README-zh.md 已补充 Python 3.9+ 最低版本要求,并说明当前环境需要能访问 https://mcp.deepwiki.com/mcp

Use $hugegraph-deepwiki-skill to explain HugeGraph schema and traversal behavior.
```

HugeGraph AI 相关问题请安装 `apache/hugegraph-ai` 仓库中的独立 HugeGraph AI 仓库知识助手。
121 changes: 121 additions & 0 deletions tools/ai/hugegraph-deepwiki-skill/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# HugeGraph 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](https://github.com/apache/hugegraph) source repository.

DeepWiki is used as the online knowledge and MCP transport layer:

```text
https://deepwiki.com/apache/hugegraph
https://mcp.deepwiki.com/mcp
```

## What It Does

- Answers repository-grounded questions about HugeGraph architecture, modules, APIs, storage backends, schema, traversal, configuration, build, tests, 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.9 or later for the bundled MCP client script.
- Network access to `https://mcp.deepwiki.com/mcp`.

## Layout

```text
tools/ai/hugegraph-deepwiki-skill/
├── README.md
├── README-zh.md
├── .agents/plugins/marketplace.json
├── .claude-plugin/marketplace.json
└── plugins/hugegraph-deepwiki-skill/
├── .claude-plugin/plugin.json
├── .codex-plugin/plugin.json
└── skills/hugegraph-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-deepwiki-skill
claude plugin marketplace add "$(pwd)"
claude plugin install hugegraph-deepwiki-skill@hugegraph-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.git
cd hugegraph/tools/ai/hugegraph-deepwiki-skill
claude plugin marketplace add "$(pwd)"
claude plugin install hugegraph-deepwiki-skill@hugegraph-deepwiki-skill
```

Manual user-level skill install:

```bash
mkdir -p ~/.claude/skills
cp -R plugins/hugegraph-deepwiki-skill/skills/hugegraph-deepwiki-skill ~/.claude/skills/
```

### Ask Claude Code To Install It

Paste this into Claude Code from the HugeGraph repository root:

```text
Install the HugeGraph repository assistant from this checkout. Enter `tools/ai/hugegraph-deepwiki-skill`, run `claude plugin marketplace add "$(pwd)"`, then run `claude plugin install hugegraph-deepwiki-skill@hugegraph-deepwiki-skill`. Do not hardcode absolute paths.
```

## Codex Install

From this repository:

```bash
cd tools/ai/hugegraph-deepwiki-skill
codex plugin marketplace add "$(pwd)"
codex plugin add hugegraph-deepwiki-skill@hugegraph-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.git
cd hugegraph/tools/ai/hugegraph-deepwiki-skill
codex plugin marketplace add "$(pwd)"
codex plugin add hugegraph-deepwiki-skill@hugegraph-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-deepwiki-skill/skills/hugegraph-deepwiki-skill "$CODEX_HOME/skills/"
```

### Ask Codex To Install It

Paste this into Codex from the HugeGraph repository root:

```text
Install the HugeGraph repository assistant from this checkout. Enter `tools/ai/hugegraph-deepwiki-skill`, run `codex plugin marketplace add "$(pwd)"`, then run `codex plugin add hugegraph-deepwiki-skill@hugegraph-deepwiki-skill`. If this Codex build has no plugin add command, copy `plugins/hugegraph-deepwiki-skill/skills/hugegraph-deepwiki-skill` into `${CODEX_HOME:-$HOME/.codex}/skills`. Do not hardcode absolute paths.
```

## Usage

After installation, ask for the skill explicitly when needed:

```text
Comment on lines +113 to +117
Use $hugegraph-deepwiki-skill to explain HugeGraph schema and traversal behavior.
```

For HugeGraph AI questions, install the separate HugeGraph AI repository assistant from the `apache/hugegraph-ai` repository instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"name": "hugegraph-deepwiki-skill",
"description": "Repository knowledge assistant for Apache HugeGraph.",
"version": "0.1.4",
"author": {
"name": "HugeGraph Community"
},
"homepage": "https://github.com/apache/hugegraph",
"repository": "https://github.com/apache/hugegraph",
"license": "Apache-2.0",
"keywords": ["hugegraph", "deepwiki", "apache", "knowledge-assistant"],
"skills": "./skills/"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "hugegraph-deepwiki-skill",
"version": "0.1.4",
"description": "Repository knowledge assistant for Apache HugeGraph.",
"author": {
"name": "HugeGraph Community",
"email": "",
"url": "https://github.com/apache/hugegraph"
},
"homepage": "https://github.com/apache/hugegraph",
"repository": "https://github.com/apache/hugegraph",
"license": "Apache-2.0",
"keywords": ["hugegraph", "deepwiki", "apache", "knowledge-assistant"],
"skills": "./skills/",
"interface": {
"displayName": "HugeGraph Repository Assistant",
"shortDescription": "Ask repository-grounded questions about Apache HugeGraph.",
"longDescription": "Provides an Apache HugeGraph repository knowledge assistant for architecture, API, configuration, storage, traversal, schema, 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",
"defaultPrompt": [
"Use $hugegraph-deepwiki-skill to answer my HugeGraph repository question."
],
"brandColor": "#2563EB"
}
}
Loading