Skip to content

block-88/codebase-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@inkr/codebase-mcp

License: MIT

An MCP (Model Context Protocol) server designed to provide tools for interacting with codebases, leveraging generative AI capabilities. This server allows AI agents or other MCP clients to ask questions about a specified codebase path.

✨ Features

  • Codebase Interaction: Provides an MCP tool (ask_codebase) to query information about codebases.
  • Generative AI Integration: Utilizes @google/genai for processing and answering codebase-related questions.
  • Stdio Transport: Communicates using the standard MCP stdio transport mechanism.

📚 Table of Contents

🚀 Usage

This project runs as an MCP server. It's typically invoked by an MCP client or controller.

Connecting an MCP Client

Follow the configurations in these files, remember to update env inside with your preference:

Environment Variables

Variable Description Required Default
GEMINI_API_KEY Your Gemini API key Yes
MODEL The model to use for codebase analysis No gemini-2.0-flash
CODEBASE_PATH The path to the codebase No (current working directory)

Tools

Once connected, the client can invoke the tools provided by this server.

ask_codebase

Argument Description Required Default
question The question to ask about the codebase Yes
path The path of the file or directory to query, relative to CODEBASE_PATH No (Use CODEBASE_PATH)

⚙️ Development

Prerequisites

Steps

  1. Install dependencies:

    bun install
  2. Configuration (if necessary):

    • Check if any specific environment variables are required for @google/genai (e.g., API keys). Create a .env file if needed. (Further investigation might be needed to confirm required variables).
  3. Run:

    • In IDEs: Reload window and check if the MCP is connected
    • Manually: Run ./run in your terminal

💻 Technology Stack

📜 License

This project is licensed under the MIT License - see the LICENSE file for details. Copyright (c) 2025 INKR Global

📧 Contact

About

An MCP to access codebase and related helpers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •