
deepwiki
Query DeepWiki for repository documentation and structure. Use to understand open source projects, find API docs, and explore codebases.
- Installs
- 269
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/johnlindquist/claude --skill deepwiki- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads deepwiki automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
DeepWiki - Repository Documentation
Query DeepWiki for AI-generated documentation about any public GitHub repository.
Overview
DeepWiki (deepwiki.com) provides AI-generated documentation for GitHub repositories, including:
- Repository structure and architecture
- API documentation
- Code explanations
- Interactive diagrams
Quick Start
URL Pattern: Replace github.com with deepwiki.com in any repo URL:
github.com/vercel/next.js→deepwiki.com/vercel/next.js
MCP Server Setup
DeepWiki provides a free MCP server with no authentication required for public repos.
Add to Claude Code (one-time setup)
claude mcp add -s user -t http deepwiki https://mcp.deepwiki.com/mcp
For Cursor/Windsurf
Add to your MCP config:
{
"mcpServers": {
"deepwiki": {
"serverUrl": "https://mcp.deepwiki.com/sse"
}
}
}
Available MCP Tools
Once configured, these tools become available:
| Tool | Purpose |
|---|---|
read_wiki_structure | Get documentation topics/structure for a repo |
read_wiki_contents | Retrieve actual documentation content |
ask_question | Ask AI-powered questions about the repo |
Usage Examples
Via WebFetch (works immediately)
# Fetch documentation overview
WebFetch https://deepwiki.com/owner/repo "Summarize the architecture"
# Example
WebFetch https://deepwiki.com/vercel/next.js "How does routing work?"
Via MCP (after setup)
Use the MCP tools directly:
mcp__deepwiki__read_wiki_structure- Get repo structuremcp__deepwiki__read_wiki_contents- Get documentationmcp__deepwiki__ask_question- Ask questions
Fallback: GitHub + AI
If DeepWiki lacks coverage for a repo, use GitHub API:
Get Repository Overview
gh api repos/owner/repo | jq '{description, language, topics, stars: .stargazers_count}'
Get README
gh api repos/owner/repo/readme --jq '.content' | base64 -d
Get File Structure
gh api repos/owner/repo/git/trees/main?recursive=1 | \
jq -r '.tree[] | select(.type == "blob") | .path' | head -50
Wire Protocols
Two protocols are supported:
- SSE at
https://mcp.deepwiki.com/sse- Official MCP spec - HTTP at
https://mcp.deepwiki.com/mcp- Cloudflare/OpenAI compatible
Best Practices
- Use WebFetch first - Works without MCP setup
- Check if repo is indexed - Popular repos have better coverage
- Ask specific questions - DeepWiki excels at targeted queries
- Fall back to GitHub - For unindexed or private repos
Limitations
- Public repos only - Private repos require Devin account
- Coverage varies - 50,000+ popular repos indexed
- No authentication - Can't access private documentation
Resources
FAQ
What does the deepwiki skill do?
Query DeepWiki for repository documentation and structure. Use to understand open source projects, find API docs, and explore codebases.
How do I install deepwiki?
Run npx skills add https://github.com/johnlindquist/claude --skill deepwiki in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/deepwiki/ (personal) or .claude/skills/deepwiki/ (project).
Which AI agents can use deepwiki?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is deepwiki safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains deepwiki?
It is published by johnlindquist in johnlindquist/claude. It has 269 recorded installs.
More from johnlindquist/claude
gemini-image
johnlindquist/claude
Analyze images using Gemini's vision capabilities. Use for image analysis, text extraction from screenshots, and visual content understanding.
brainstorm
johnlindquist/claude
Open the skill to read its SKILL.md instructions.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.