ccwiki-mcp
v0.1.6
Published
MCP server for Briefed - real-time codebase context that syncs as your team codes
Maintainers
Readme
@ccwiki/mcp
MCP server that gives Claude Code instant access to your codebase context via ccwiki.ai
What This Does
Once installed, Claude Code automatically has deep understanding of any repository you've analyzed on ccwiki.ai:
- No more re-explaining your codebase every session
- No more duplicating code that already exists
- No more guessing at patterns and conventions
- Instant context for any task you're working on
Quick Start
1. Analyze Your Repository
Visit ccwiki.ai and analyze your repository. This takes ~10 minutes and creates comprehensive documentation.
2. Get Your API Key
Go to ccwiki.ai/settings and generate an API key.
3. Configure Claude Code
Add to your Claude Code config (~/.claude/config.json):
{
"mcpServers": {
"ccwiki": {
"command": "npx",
"args": ["@ccwiki/mcp"],
"env": {
"CCWIKI_API_KEY": "your-api-key-here"
}
}
}
}4. Use It
Just start working. Claude Code now automatically has context:
> "Add a new API endpoint for user settings"
Claude knows:
- Where your existing endpoints are
- What patterns they follow
- What middleware to use
- What utilities exist to reuse
- What conventions to followAvailable Tools
Once connected, Claude Code has access to these tools:
| Tool | Description |
|------|-------------|
| ccwiki_get_context | Get relevant context for a task (patterns, files, conventions) |
| ccwiki_find_files | Find files by purpose or layer |
| ccwiki_get_conventions | Get coding conventions and anti-patterns |
| ccwiki_quickstart | Get a 60-second codebase overview |
| ccwiki_search | Search documentation for specific topics |
| ccwiki_list_repos | List your analyzed repositories |
How It Works
- Auto-detection: The MCP server detects which git repository you're in
- Lookup: It finds the matching analyzed repo on ccwiki.ai
- Context: It provides relevant context to Claude Code
- Caching: Responses are cached for fast repeat access
Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| CCWIKI_API_KEY | Your ccwiki API key | Required |
| CCWIKI_API_URL | API base URL | https://api.ccwiki.ai |
Manual Usage
You can also run the server directly:
# Show help
npx @ccwiki/mcp --help
# Show version
npx @ccwiki/mcp --version
# Run server (for testing)
CCWIKI_API_KEY=xxx npx @ccwiki/mcpTroubleshooting
"Could not find repository"
This means either:
- You're not in a git repository
- The repository hasn't been analyzed on ccwiki.ai
- The git remote URL doesn't match what's on ccwiki
Solution: Make sure the repo is analyzed at ccwiki.ai and you're in the repo directory.
"API request failed: 401"
Your API key is invalid or expired.
Solution: Generate a new API key at ccwiki.ai/settings.
Server not starting
Check that Node.js 18+ is installed:
node --version # Should be 18.x or higherDevelopment
# Install dependencies
npm install
# Build
npm run build
# Run in development
npm run dev
# Type check
npm run typecheckLicense
MIT
Links
- ccwiki.ai - Analyze your repositories
- Documentation - Full documentation
- GitHub - Source code
