DeepWiki Skill
Use this skill to query GitHub repository documentation and ask questions about codebases.
Prerequisites
- -
uxc is installed and available in PATH. - Network access to INLINECODE2
Note: Repositories must be indexed on DeepWiki first. Visit https://deepwiki.com to index a repository.
Install uxc
Choose one of the following methods:
Homebrew (macOS/Linux):
CODEBLOCK0
Install Script (macOS/Linux, review before running):
CODEBLOCK1
Cargo:
CODEBLOCK2
Core Workflow
- 1. 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.
- 2. Ask a question about a repository:
- INLINECODE6
- 3. Read wiki structure:
- INLINECODE7
- 4. Read wiki contents:
- INLINECODE8
Available Tools
- - askquestion: Ask any question about a GitHub repository and get an AI-powered response
- readwikistructure: Get a list of documentation topics for a repository
- readwiki_contents: View documentation about a repository
Usage Examples
Ask about a codebase
CODEBLOCK3
Explore repository structure
CODEBLOCK4
Read documentation
CODEBLOCK5
Output Parsing
The response is an MCP JSON envelope. Extract the content from .data.content[].text.
Notes
- - Maximum 10 repositories per question
- Some popular repositories may already be indexed
- Responses are grounded in the actual codebase
- INLINECODE10 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.
Reference Files
- - Workflow details: INLINECODE13
DeepWiki 技能
使用此技能查询 GitHub 仓库文档并询问关于代码库的问题。
前置条件
- - uxc 已安装并可在 PATH 中使用。
- 可访问 mcp.deepwiki.com/mcp 网络。
注意：仓库必须先在 DeepWiki 上建立索引。请访问 https://deepwiki.com 为仓库建立索引。
安装 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
核心工作流程
- 1. 默认使用固定链接命令：
- command -v deepwiki-mcp-cli
- 如果缺失，则创建：uxc link deepwiki-mcp-cli mcp.deepwiki.com/mcp
- deepwiki-mcp-cli -h
- 如果检测到命令冲突且无法安全重用，请停止并让技能维护者选择不同的固定命令名称。
- 2. 询问关于仓库的问题：
- deepwiki-mcp-cli ask_question repoName=owner/repo question=你的问题
- 3. 读取 Wiki 结构：
- deepwiki-mcp-cli read
wikistructure repoName=owner/repo
- 4. 读取 Wiki 内容：
- deepwiki-mcp-cli read
wikicontents repoName=owner/repo
可用工具
- - askquestion：询问关于 GitHub 仓库的任何问题，并获得 AI 驱动的回答
- readwikistructure：获取仓库的文档主题列表
- readwiki_contents：查看关于仓库的文档
使用示例
询问代码库
bash
deepwiki-mcp-cli ask_question repoName=facebook/react question=useState 是如何工作的？
探索仓库结构
bash
deepwiki-mcp-cli readwikistructure {repoName:facebook/react}
阅读文档
bash
deepwiki-mcp-cli readwikicontents repoName=facebook/react
输出解析
响应是一个 MCP JSON 信封。从 .data.content[].text 中提取内容。
注意事项
- - 每个问题最多 10 个仓库
- 一些热门仓库可能已经建立了索引
- 响应基于实际代码库
- deepwiki-mcp-cli <操作> ... 等同于 uxc mcp.deepwiki.com/mcp <操作> ...。
- 如果链接设置暂时不可用，请直接使用 uxc mcp.deepwiki.com/mcp ... 调用作为备选方案。
参考文件
- - 工作流程详情：references/usage-patterns.md
