deepwiki
Scannednpx machina-cli add skill petekp/claude-code-setup/deepwiki --openclawDeepWiki - 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
Source
git clone https://github.com/petekp/claude-code-setup/blob/main/skills/deepwiki/SKILL.mdView on GitHub Overview
DeepWiki provides AI-generated documentation for GitHub repositories, including repository structure, architecture, API documentation, code explanations, and interactive diagrams. It helps developers understand open-source projects quickly and locate relevant docs. This is especially useful when onboarding to a new codebase or evaluating dependencies.
How This Skill Works
Access DeepWiki by swapping github.com with deepwiki.com in a repo URL to fetch docs via WebFetch. For deeper queries, configure Claude Code with the MCP server (SSE or HTTP) and use the read_wiki_structure, read_wiki_contents, and ask_question tools. If coverage is missing, fall back to the GitHub API for overview, README, and file structure.
When to Use It
- When you need a repo's structure and architecture at a glance
- When you need AI-generated API documentation for a project
- When you want code explanations or interactive diagrams
- When you want to explore public repos without authenticating
- When coverage is missing and you should fall back to GitHub API
Quick Start
- Step 1: Replace github.com with deepwiki.com in the repo URL (e.g., github.com/vercel/next.js → deepwiki.com/vercel/next.js)
- Step 2: Add DeepWiki to Claude Code MCP: claude mcp add -s user -t http deepwiki https://mcp.deepwiki.com/mcp
- Step 3: If using Cursor/Windsurf, add to your MCP config a section like: { "mcpServers": { "deepwiki": { "serverUrl": "https://mcp.deepwiki.com/sse" } } }
Best Practices
- Start with WebFetch to get quick results before MCP setup
- Check if the repository is indexed; popular repos have better coverage
- Ask specific questions to leverage AI-generated insights
- Use MCP tools for deeper queries (structure, contents, Q&A)
- If coverage is insufficient, fall back to GitHub API for an overview and README
Example Use Cases
- WebFetch https://deepwiki.com/vercel/next.js 'Summarize the architecture'
- WebFetch https://deepwiki.com/facebook/react 'How does data flow between components?'
- mcp__deepwiki__read_wiki_structure to fetch repo layout for vercel/next.js
- mcp__deepwiki__read_wiki_contents to retrieve API docs for vercel/next.js
- gh api repos/vercel/next.js/readme --jq '.content' | base64 -d
