CodeWiki MCP Server
Fetches and caches documentation for GitHub repositories via Google CodeWiki, enabling search of repository documentation, viewing cached repositories, and managing the documentation cache.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@CodeWiki MCP Serversearch for React documentation on hooks"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
CodeWiki MCP Server
An MCP (Model Context Protocol) server that integrates with Google CodeWiki to fetch and cache documentation for GitHub repositories.
Features
Repository Search: Search for GitHub repositories on Google CodeWiki
Documentation Fetching: Retrieve and parse documentation from CodeWiki
Smart Caching: Cache documentation with TTL (Time To Live) to avoid repeated requests
Documentation Search: Search within cached documentation for specific content
Cache Management: List, clear, and manage cached repositories
Installation
Clone this repository
Install dependencies:
npm installBuild the project:
npm run build
Setup
VS Code Integration
The project includes VS Code MCP configuration. The .vscode/mcp.json file is automatically created during setup and configures the server for use with MCP-compatible clients.
Git Configuration
A comprehensive .gitignore file is included to exclude:
Build outputs (
dist/,build/)Cache directories (
.codewiki-cache/)Environment files (
.env*)IDE files (
.vscode/,.idea/)OS files (
.DS_Store,Thumbs.db)Logs and temporary files
Usage
As an MCP Server
This server can be used with any MCP-compatible client. The server provides the following tools:
search_repository
Search for GitHub repositories on Google CodeWiki.
Parameters:
query(string): Search query for repository name or owner/repo format
Example:
{
"query": "facebook/react"
}get_repository_docs
Get documentation for a specific GitHub repository.
Parameters:
owner(string): Repository owner/organizationrepo(string): Repository nameforce_refresh(boolean, optional): Force refresh cached documentation (default: false)
Example:
{
"owner": "facebook",
"repo": "react",
"force_refresh": false
}search_documentation
Search within cached documentation for a repository.
Parameters:
owner(string): Repository owner/organizationrepo(string): Repository namequery(string): Search query within the documentation
Example:
{
"owner": "facebook",
"repo": "react",
"query": "hooks"
}list_cached_repositories
List all repositories currently cached.
Parameters: None
clear_cache
Clear the documentation cache.
Parameters:
owner(string, optional): Specific repository owner to clearrepo(string, optional): Repository name when clearing specific repo
Examples:
{
"owner": "facebook",
"repo": "react"
}{}Direct Usage
You can also run the server directly:
npm startConfiguration
Cache Settings
The cache manager supports the following configuration:
Default TTL: 24 hours (configurable)
Cache Directory:
.codewiki-cachein the project rootMemory Cache: In-memory cache for frequently accessed data
Disk Cache: Persistent cache stored as JSON files
Environment Variables
CODEWIKI_CACHE_DIR: Custom cache directory pathCODEWIKI_CACHE_TTL: Cache TTL in milliseconds (default: 86400000)
Project Structure
codewiki-mcp-server/
├── src/
│ ├── server.ts # Main MCP server implementation
│ ├── codewiki-client.ts # Client for interacting with Google CodeWiki
│ └── cache-manager.ts # Manages caching of documentation
├── .vscode/
│ └── mcp.json # MCP server configuration for VS Code
├── .gitignore # Git ignore rules
├── LICENSE # MIT License
├── README.md # This file
├── mcp.json # MCP server manifest
├── package.json # Project dependencies and scripts
└── tsconfig.json # TypeScript configurationArchitecture
Components
Server (
server.ts): Main MCP server implementationCodeWikiClient (
codewiki-client.ts): Client for interacting with Google CodeWikiCacheManager (
cache-manager.ts): Manages caching of documentation
Data Flow
Client requests repository documentation
Server checks cache for existing data
If not cached or expired, fetches from Google CodeWiki
Parses and structures the documentation
Stores in cache for future requests
Returns structured documentation to client
Development
Building
npm run buildDevelopment Mode
npm run devCleaning
npm run cleanLimitations
No Public API: Google CodeWiki doesn't provide a public API, so this server uses web scraping
Rate Limiting: Be respectful of CodeWiki's servers with appropriate delays
Repository Coverage: Not all repositories may have CodeWiki documentation available
Content Parsing: HTML structure changes on CodeWiki may require updates to the parsing logic
Contributing
Fork the repository
Create a feature branch
Make your changes
Add tests if applicable
Submit a pull request
License
MIT License - see LICENSE file for details.
Author
Chris Bunting cbuntingde@gmail.com
Available Tools
5 toolsclear_cacheC
Clear the documentation cache
| Name | Required | Description | Default |
|---|---|---|---|
| owner | No | Specific repository to clear (optional) | |
| repo | No | Repository name when clearing specific repo |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. 'Clear' implies a destructive operation that removes cached data, but the description doesn't specify what 'clear' entails (e.g., complete wipe, selective removal, irreversible action), whether it requires permissions, or what happens after clearing. It lacks details on side effects or operational constraints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste. It's front-loaded with the core action and resource, making it easy to parse quickly. No unnecessary words or structural issues detract from clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (a destructive operation with optional targeting) and lack of annotations or output schema, the description is incomplete. It doesn't explain the outcome (e.g., success confirmation, error handling), the scope of clearing (all vs. specific), or behavioral nuances. For a mutation tool with zero annotation coverage, more context is needed to guide safe and effective use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters (owner and repo) as optional strings for targeting specific repositories. The description doesn't add any parameter semantics beyond what the schema provides, such as explaining when to use these parameters or the effect of omitting them. Baseline 3 is appropriate when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Clear the documentation cache' clearly states the action (clear) and target (documentation cache). It's specific about what resource is affected, though it doesn't differentiate from sibling tools like 'list_cached_repositories' or 'search_documentation' which have different purposes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. There's no mention of prerequisites, when clearing is appropriate, or how this differs from related operations like refreshing or searching documentation. Users must infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_repository_docsC
Get documentation for a specific GitHub repository
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner/organization | |
| repo | Yes | Repository name | |
| force_refresh | No | Force refresh cached documentation |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure but provides minimal information. It mentions 'documentation' but doesn't specify what format is returned (e.g., README, wiki pages, API docs), whether authentication is required, if there are rate limits, or how the 'force_refresh' parameter affects behavior. The description doesn't contradict annotations since none exist, but it fails to provide adequate behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, clear sentence that efficiently communicates the core purpose without unnecessary words. It's appropriately sized for a simple retrieval tool and front-loads the essential information. Every word earns its place in this concise formulation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 3 parameters, no annotations, and no output schema, the description is insufficiently complete. It doesn't explain what 'documentation' means in this context, what format the results take, whether authentication is needed, or how errors are handled. The presence of a 'force_refresh' parameter suggests caching behavior that should be explained but isn't addressed in the description.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters thoroughly. The description adds no additional parameter semantics beyond what's in the schema - it doesn't explain what 'documentation' encompasses or provide examples of owner/repo values. This meets the baseline expectation when schema coverage is complete.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Get documentation') and resource ('for a specific GitHub repository'), making the purpose immediately understandable. It distinguishes from siblings like 'search_documentation' by focusing on retrieval for a specific repo rather than searching across repos. However, it doesn't explicitly differentiate from 'list_cached_repositories' which might also involve documentation access.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose this over 'search_documentation' for finding docs, or how it relates to 'list_cached_repositories' which might show cached documentation. There's no indication of prerequisites, error conditions, or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_cached_repositoriesB
List all repositories currently cached
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It states what the tool does but reveals nothing about permissions needed, rate limits, response format, pagination, or whether the operation is idempotent. For a tool with zero annotation coverage, this is insufficient behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that communicates the core purpose without any wasted words. It's appropriately sized for a simple list operation and front-loads the essential information immediately.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter tool with no output schema, the description provides the minimum viable information about what the tool does. However, it lacks important context about the response format, caching behavior implications, and how this differs from sibling search tools, leaving gaps in overall completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters with 100% schema description coverage, so no parameter documentation is needed. The description appropriately doesn't discuss parameters, earning a baseline score of 4 for correctly handling this parameterless scenario.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('List') and target resource ('repositories currently cached'), making the purpose immediately understandable. It doesn't distinguish from sibling tools like 'get_repository_docs' or 'search_repository', but the verb+resource combination is specific enough for basic understanding.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'search_repository' or 'get_repository_docs'. There's no mention of prerequisites, timing considerations, or comparison with sibling tools, leaving the agent to infer usage context independently.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_documentationC
Search within cached documentation for a repository
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner/organization | |
| repo | Yes | Repository name | |
| query | Yes | Search query within the documentation |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'cached documentation', implying a read-only operation, but doesn't specify aspects like search scope (e.g., full-text, titles only), performance, rate limits, or error handling. This leaves significant gaps for a search tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that directly states the tool's function without unnecessary words. It's front-loaded and wastes no space, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of a search operation with no annotations and no output schema, the description is incomplete. It lacks details on behavioral traits (e.g., search behavior, caching implications) and output expectations, which are crucial for effective tool use in this context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, clearly documenting the three required parameters. The description adds no additional meaning beyond the schema (e.g., it doesn't explain how 'query' is processed or what 'owner' and 'repo' refer to), so it meets the baseline but doesn't enhance understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Search within cached documentation') and the resource ('for a repository'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'search_repository' or 'get_repository_docs', which likely have overlapping domains, so it misses the highest score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'search_repository' or 'get_repository_docs'. It mentions 'cached documentation' but doesn't clarify prerequisites (e.g., if docs must be pre-cached) or exclusions, leaving usage context vague.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_repositoryC
Search for a GitHub repository on Google CodeWiki
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query for repository name or owner/repo format |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden for behavioral disclosure. While 'Search' implies a read operation, the description doesn't disclose whether this requires authentication, has rate limits, what the return format looks like, whether it searches live data or cached repositories, or any other behavioral traits. For a search tool with zero annotation coverage, this is inadequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that communicates the core purpose without unnecessary words. It's appropriately sized for a simple search tool and front-loads the essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a search tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what 'Google CodeWiki' is, what kind of results to expect, whether this searches across all GitHub or a specific subset, or how results are returned. The lack of output schema means the description should compensate by explaining return values, which it doesn't do.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with the single parameter 'query' already documented in the schema as 'Search query for repository name or owner/repo format'. The description doesn't add any additional semantic context about parameter usage beyond what the schema provides, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Search for') and resource ('a GitHub repository on Google CodeWiki'), providing a specific verb+resource combination. However, it doesn't differentiate from sibling tools like 'search_documentation' or 'list_cached_repositories' - it's unclear if this searches across all repositories or only cached ones, or how it differs from documentation search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided about when to use this tool versus alternatives. With sibling tools like 'search_documentation', 'list_cached_repositories', and 'get_repository_docs', the description offers no context about when this repository search is appropriate versus those other search/list operations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
5 tool updates
v1.0.0- First observed
clear_cache - First observed
get_repository_docs - First observed
list_cached_repositories - First observed
search_documentation - First observed
search_repository
TDQS
Each tool has a clearly distinct purpose with no overlap. clear_cache manages cache, get_repository_docs retrieves specific docs, list_cached_repositories shows cached items, search_documentation searches within cached content, and search_repository finds repositories externally. The boundaries are well-defined and unambiguous.
The naming follows a consistent verb_noun pattern (e.g., clear_cache, get_repository_docs, list_cached_repositories) with all tools using snake_case. The only minor deviation is that 'search_repository' might be more consistent as 'search_repositories' to match plural forms, but overall the pattern is highly predictable and readable.
With 5 tools, the count is well-scoped for a documentation-focused server. Each tool serves a specific function in the workflow (caching, retrieving, listing, searching), and there are no redundant or missing tools that would make the set feel too thin or bloated for its purpose.
The toolset covers core documentation workflows effectively: caching management, repository retrieval, listing, and searching both internally and externally. A minor gap is the lack of update or delete operations for cached documentation, but agents can work around this by clearing and re-fetching, and the surface is otherwise complete for the stated purpose.
Related MCP Connectors
A cited wiki of your GitHub repo: search, read pages, find symbols and ask, with line citations.
Ask any GitHub repository a question. Get source-backed answers.
Code intelligence for LLMs. Analyze, search, and retrieve code from any public git repository.
Access the GitHub API, enabling file operations, repository management, search functionality, and…
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/cbuntingde/codewiki-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server