Codebase Symbols

You can run an MCP server that scans your entire codebase to extract all symbols (functions, classes, methods, interfaces, etc.) and present them in a concise, token-efficient Markdown format tailored for language models. This server helps you get a complete, navigable map of your code without exposing full source files, supports multiple languages, and respects your project’s ignore rules to keep results focused and secure.

How to use

Configure your MCP client to point to the local or remote MCP server, then invoke the analyze_codebase tool with the path to your project. The server will load your project’s .gitignore, scan all code files, extract symbols, and return a structured Markdown document that summarizes the codebase structure, symbols, and locations.

How to install

Prerequisites: Node.js and npm must be installed on your machine. Ensure you have a working development environment for running JavaScript/TypeScript code.

# Install dependencies
npm install

# Build the project
npm run build

Configuration

Configure the MCP client to connect to the local server using the stdio command shown in the example. The server runs locally and does not require sending code to external endpoints.

{
  "mcpServers": {
    "codebase_symbols": {
      "command": "node",
      "args": [
        "C:\\Users\\darci\\desenvolvimento\\MyCode MCP\\dist\\index.js"
      ]
    }
  }
}

Security and privacy notes

The server operates locally on your machine. Only symbols and structural information are extracted, not full source code. It respects .gitignore to avoid exposing sensitive files.

Troubleshooting

If you don’t see results, verify that the path to your project is correct and that npm install completed successfully. Ensure Node.js is accessible in your environment. Check that the built artifact exists at the path specified in the config.

Examples of usage

After configuring the MCP client, you can run the analyze_codebase tool on a project path such as C:\my_project to obtain a structured Markdown summary of directories, files, and symbols.

Available tools

analyze_codebase

Analyzes a codebase at a given path and returns a structured Markdown document with overall statistics, directory structure, and per-file symbol details.