
yeuxuan/ace-mcp-node
API developmentThis page was translated automatically. Technical details may differ from the original. View the original
Acemcp is a high-performance MCP (Model Context Protocol) server designed to provide codebase indexing and semantic search capabilities for AI assistants such as Claude, GPT, etc. With Acemcp, AI assistants can: 🔍 quickly search and understand large codebases 📊, obtain precise code snippets 🤖 with line numbers, automatically update 🌐 indexes incrementally, and manage and debug via a web interface
Overview
It is a high-performance MCP (Model Context Protocol) server, designed to provide ** and ** capabilities for AI assistants (such as Claude, GPT, etc.). Through Acemcp, AI assistants can: - 🔍 Quickly search and understand large codebases - 📊 Get precise code snippets with line numbers - 🤖 Automatic incremental index updates - 🌐 Manage and debug via web interface - ✅ - Only indexes new or modified files - ✅ - Supports batch operations and automatic retries - ✅ - Large files are automatically split into multiple blocks - ✅ - SHA-256 hash prevents duplicate uploads - ✅ - Full type support - ✅ - Real-time logging, configuration management, tool debugging - ✅ Automatic exclusion of irrelevant files - ✅ - Configurable log levels and rotation - ✅ - Unified processing of Windows/Unix paths - ✅ - UNC path, /mnt automatic conversion - ✅ - UTF-8, GBK, GB2312, Latin-1 - ✅ - Shared configuration and data formats - ✅ - Full implementation of SDK - ✅ - Semantic search code snippets - ✅ - Standard input/output communication - ✅ - Command line parameters + configuration files - > = 18.0.0 - > = 8.0.0 (or yarn, pnpm) - : Windows 10+, Linux, macOS, WSL 2 Access http://localhost:8080 using the graphical interface: - 📊 View server status - ⚙️ Edit configuration file - 📝 View real-time logs - Tool 🛠 debug testing
Overview (machine translated)
📑 Table of Contents
- Introduction
- Core features
- Start quickly
- Installation
- Configuration
- User guide
- MCP client configuration
- Tool description
- Web management interface
- WSL support
- API documentation
- Example scenario
- Development guide
- Troubleshooting
- Compatibility
- Contribution
- License
📖 Introduction
Acemcp is a high-performance MCP (Model Context Protocol) server designed for AI assistants (such as Claude, GPT, etc.) to provide codebase indexing and semantic search capabilities. With Acemcp, AI assistants can:
- 🔍 Quickly search and understand large codebases
- 📊 Obtain precise code snippets with line numbers
- 🤖 Automatic incremental index updates
- 🌐 Manage and debug via a web interface
**Why choose ACEMCP? **
| Features | Description |
|---|---|
| Zero Configuration Startup | Configuration is automatically generated on the first run |
| Incremental Index | Only handles change files, fast and efficient |
| Cross-Platform | Fully supported for Windows, Linux, macOS, and WSL |
| Multi-code | Automatically detects UTF-8, GBK, GB2312, Latin-1 |
| AI-Friendly | Returns formatted code snippets with file paths and line numbers |
⭐ Core Features
🚀 Performance Optimization
- ✅ Incremental Index - Only indexes new or modified files
- ✅ Batch Upload - Supports batch operations and automatic retrys
- ✅ Smart Splitting - Automatically splits large files into multiple blocks
- ✅ Caching Mechanism - SHA-256 hash prevents duplicate uploads
🛠 Developer-friendly
- ✅ TypeScript - Full type support
- ✅ Web interface - Real-time logging, configuration management, tool debugging
- ✅ .gitignore support - Automatically excludes irrelevant files
- ✅ Detailed Logs - Configurable log levels and rotations
🌍 Compatibility
- ✅ Cross-Platform Paths - Unified handling of Windows/Unix paths
- ✅ Full WSL support - Automatic conversion of UNC paths and /mnt
- ✅ Multi-encoding support - UTF-8, GBK, GB2312, Latin-1
- ✅ Python version compatible - Shared configurations and data formats
🎯 MCP Integration
- ✅ Standard MCP Protocol - Full implementation of the SDK
- ✅ search_context Tools - Semantic search code snippets
- ✅ STDIO Transmission - Standard input/output communication
- ✅ Flexible Configuration - Command-line parameters + configuration file
🚀 Get Started Quickly
This page was translated automatically. Technical details may differ from the original.
Install
npx acemcp-nodeConfiguration
{
"mcpServers": {
"acemcp": {
"command": "npx",
"args": ["acemcp-node"],
"env": {}
}
}
}