Skip to main content
Glama

🌟 Key Features

  • Secure Access: Restricts file operations to predefined root directory.

  • Efficient File Management: Provides tools for reading and searching files.

  • Detailed Metadata: Retrieves comprehensive file metadata including size, creation time, last modified time, permissions, and type.

  • Dependency Analysis: Traverses and analyzes dependency trees within projects.

📋 Supported Languages

  • JavaScript/TypeScript

  • CSS / CSS Preprocessors

🛠️ Tools

  • get-project-basics: Retrieves essential project information including package.json details, directory structure.

  • search-config-files: Searches for configuration files within the root directory and returns their paths.

  • get-dependency-tree: Traverses the dependency tree based on the given file path and root directory, and returns the traversal results.

  • list-directory: Lists the contents of a specified directory, distinguishing between files and directories.

  • read-file-with-metadata: Reads the content of a specified file and retrieves its metadata.

🚀 QuickStart

Prerequisites

  • Node.js v18 or later

  • Codebase to communicate with LLM

Installation

First, install the Codebase MCP server with your client. A typical configuration looks like this:

{ "mcpServers": { "Codebase": { "command": "npx", "args": ["codebase-mcp-server@latest", "/path/to/your/codebase"] } } }

Or, you can install the Codebase MCP server with Docker.

After cloning this repository, build the Docker image:

docker build -t mcp/codebase -f .

And then add the following to your MCP servers file:

{ "mcpServers": { "Codebase": { "command": "docker", "args": [ "run", "-i", "--rm", "--mount", "type=bind,src=/path/to/your/codebase/dir,dst=/projects/path/to/your/codebase/dir,ro", "--mount", "type=bind,src=/path/to/some/file.txt,dst=/projects/path/to/some/file.txt", "mcp/codebase", "/projects" ] } } }
# For VS Code code --add-mcp '{"name":"Codebase","command":"npx","args":["codebase-mcp-server@latest"]}'

After installation, the Codebase MCP server will be available for use with your GitHub Copilot agent in VS Code.

{ "mcpServers": { "Codebase": { "command": "npx", "args": ["codebase-mcp-server@latest"] } } }

Follow Windsuff MCP documentation. Use following configuration:

{ "mcpServers": { "Codebase": { "command": "npx", "args": ["codebase-mcp-server@latest"] } } }

Follow the MCP install guide, use following configuration:

{ "mcpServers": { "Codebase": { "command": "npx", "args": ["codebase-mcp-server@latest"] } } }

🔧 Build

Local Development Build

# Install dependencies npm ci # Build TypeScript npm run build

Docker Build

# Build Docker image docker build -t mcp/codebase -f . # Or with specific tag docker build -t mcp/codebase:latest -f .

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our Code of conduct and the process for submitting pull requests.

-
security - not tested
A
license - permissive license
-
quality - not tested

Latest Blog Posts

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/MyunghoBae/codebase-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server