deepwiki-mcp-skill

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

DeepWiki Skill

Use this skill to query GitHub repository documentation and ask questions about codebases.

使用该Skill查询GitHub仓库文档并针对代码库提出问题。

Prerequisites

前提条件

```
uxc
```
is installed and available in
```
PATH
```
.
Network access to
```
mcp.deepwiki.com/mcp
```

Note: Repositories must be indexed on DeepWiki first. Visit https://deepwiki.com to index a repository.

```
uxc
```
已安装且在
```
PATH
```
环境变量中可用。
可访问
```
mcp.deepwiki.com/mcp
```
网络

注意：仓库必须先在DeepWiki中建立索引。访问https://deepwiki.com为仓库建立索引。

Install uxc

安装uxc

Choose one of the following methods:

Homebrew (macOS/Linux):

bash

brew tap holon-run/homebrew-tap
brew install uxc

Install Script (macOS/Linux, review before running):

bash

curl -fsSL https://raw.githubusercontent.com/holon-run/uxc/main/scripts/install.sh -o install-uxc.sh
less install-uxc.sh
bash install-uxc.sh

Cargo:

bash

cargo install uxc

选择以下方法之一：

Homebrew（macOS/Linux）：

bash

brew tap holon-run/homebrew-tap
brew install uxc

安装脚本（macOS/Linux，运行前请审阅）：

bash

curl -fsSL https://raw.githubusercontent.com/holon-run/uxc/main/scripts/install.sh -o install-uxc.sh
less install-uxc.sh
bash install-uxc.sh

Cargo：

bash

cargo install uxc

Core Workflow

核心工作流程

Use fixed link command by default:
- ```
command -v deepwiki-mcp-cli
```
- If missing, create it:
```
uxc link deepwiki-mcp-cli mcp.deepwiki.com/mcp
```
- ```
deepwiki-mcp-cli -h
```
- If command conflict is detected and cannot be safely reused, stop and ask skill maintainers to pick a different fixed command name.

Ask a question about a repository:

deepwiki-mcp-cli ask_question repoName=owner/repo question='your question'

Read wiki structure:

deepwiki-mcp-cli read_wiki_structure repoName=owner/repo

Read wiki contents:

deepwiki-mcp-cli read_wiki_contents repoName=owner/repo

默认使用固定链接命令：
- ```
command -v deepwiki-mcp-cli
```
- 若缺失，创建链接：
```
uxc link deepwiki-mcp-cli mcp.deepwiki.com/mcp
```
- ```
deepwiki-mcp-cli -h
```
- 若检测到命令冲突且无法安全复用，请停止操作并联系Skill维护者选择其他固定命令名称。

针对仓库提出问题：

deepwiki-mcp-cli ask_question repoName=owner/repo question='your question'

查看Wiki结构：

deepwiki-mcp-cli read_wiki_structure repoName=owner/repo

查看Wiki内容：

deepwiki-mcp-cli read_wiki_contents repoName=owner/repo

Available Tools

可用工具

ask_question: Ask any question about a GitHub repository and get an AI-powered response
read_wiki_structure: Get a list of documentation topics for a repository
read_wiki_contents: View documentation about a repository

ask_question：针对GitHub仓库提出任意问题并获得AI生成的回复
read_wiki_structure：获取仓库的文档主题列表
read_wiki_contents：查看仓库的文档内容

Usage Examples

使用示例

Ask about a codebase

询问代码库相关问题

bash

deepwiki-mcp-cli ask_question repoName=facebook/react question='How does useState work?'

bash

deepwiki-mcp-cli ask_question repoName=facebook/react question='How does useState work?'

Explore repository structure

探索仓库结构

bash

deepwiki-mcp-cli read_wiki_structure '{"repoName":"facebook/react"}'

bash

deepwiki-mcp-cli read_wiki_structure '{"repoName":"facebook/react"}'

Read documentation

阅读文档

bash

deepwiki-mcp-cli read_wiki_contents repoName=facebook/react

bash

deepwiki-mcp-cli read_wiki_contents repoName=facebook/react

Output Parsing

输出解析

The response is an MCP JSON envelope. Extract the content from

.data.content[].text

响应为MCP JSON信封。从

.data.content[].text

中提取内容。

Notes

注意事项

Maximum 10 repositories per question
Some popular repositories may already be indexed
Responses are grounded in the actual codebase

deepwiki-mcp-cli <operation> ...

is equivalent to

uxc mcp.deepwiki.com/mcp <operation> ...

If link setup is temporarily unavailable, use direct
```
uxc mcp.deepwiki.com/mcp ...
```
calls as fallback.

每个问题最多支持10个仓库
部分热门仓库可能已建立索引
回复基于实际代码库生成

deepwiki-mcp-cli <operation> ...

等同于

uxc mcp.deepwiki.com/mcp <operation> ...

。

若链接设置暂时不可用，可使用直接调用
```
uxc mcp.deepwiki.com/mcp ...
```
作为备选方案。

Reference Files

参考文件

Workflow details:
```
references/usage-patterns.md
```

工作流程详情：
```
references/usage-patterns.md
```