内容
# CueMap MCP 服务器
CueMap 的 [模型上下文协议(MCP)](https://modelcontextprotocol.io/) 服务器,允许 AI 编程助手(如 Claude Desktop、Cursor、Windsurf 和 Antigravity)使用 CueMap 引擎立即回忆代码库上下文。
## 零配置部署
CueMap MCP 服务器设计为开箱即用。当启动时,它会自动在后台管理高性能的 Rust 实例的 CueMap 服务器。
您**不需要**手动安装或运行 CueMap CLI。适用于您操作系统的正确预编译二进制文件将通过可选的 NPM 依赖项自动下载。
## 安装
```bash
# 全局安装使 `cuemap-mcp` 命令可用
npm install -g cuemap-mcp
```
*(注意:确保您的包管理器配置为下载 `optionalDependencies`,以便包含本地 Rust 二进制文件)。*
## 配置(环境变量)
默认情况下,嵌入式引擎在 `8080` 端口运行。您可以通过在 MCP 配置中传递以下环境变量来自定义服务器行为:
- `CUEMAP_PORT`:覆盖嵌入式引擎绑定的端口(默认值:`8080`)。
- `CUEMAP_CONFIG_PATH`:自定义 `server_config.toml` 的绝对路径,用于配置高级引擎调优、后台作业和 RAG 搜索参数。
- `CUEMAP_URL`:如果您更喜欢绕过嵌入式引擎并连接到远程托管或单独运行的 CueMap 服务器,请在此处指定其 URL(例如 `http://localhost:8080`)。
## 与 AI 代理一起使用
要将此 MCP 服务器与您的 AI 助手一起使用,请将其添加到您的助手的 MCP 配置文件中。
### 示例配置(Claude Desktop)
```json
{
"mcpServers": {
"cuemap": {
"command": "npx",
"args": [
"-y",
"cuemap-mcp"
],
"env": {
"CUEMAP_PORT": "8080"
}
}
}
}
```
## 可用工具
- **`cuemap_init`**: 自动为给定的本地仓库路径初始化 CueMap 项目。这会触发 Self-Learning Agent 立即摄取代码库,以便可以使用 `cuemap_recall`。
- `path`(字符串):本地仓库的绝对路径。
- `projectName`(字符串,可选):要创建的项目的 ID。默认为路径的文件夹名称。
- **`cuemap_add`**: 在显式项目中存储一个自然语言记忆。如果项目不存在,则会自动创建。
- `content`(字符串):要存储的记忆内容。
- `project`(字符串):拥有该记忆的项目 ID。
- `cues`(字符串[],可选):与记忆关联的显式提示/标签。
- `metadata`(对象,可选):要与记忆一起存储的 JSON 元数据。
- `source_key`(字符串,可选):用于确定性更新/去重的稳定源键。
- `cuepacks`(字符串[],可选):在确定性提示提取过程中应用的 CuePack 名称。
- `disable_temporal_chunking`(布尔值,可选):禁用此记忆的时间分块。
- `async_ingest`(布尔值,可选):在后台处理摄取并立即返回。
- **`cuemap_recall`**: 从 CueMap 集成的脑中回忆代码库的上下文。使用自然语言和语义搜索查找相关信息。
- `query`(字符串):要搜索的自然语言查询。
- `limit`(数字,可选):返回的最大结果数(默认值:10)。
- `projects`(字符串[],可选):搜索范围内的项目 ID 列表。多个项目启用跨项目查询。
- `cues`(字符串[],可选):用于过滤搜索的特定提示标签。
- `query_time`(字符串,可选):v0.7 时间查询意图的时间戳或自然语言时间锚点。
- `depth`(数字,可选):多跳回忆扩展器的深度(默认值:1)。
- `expansion_depth`(数字,可选):别名/提示扩展深度(默认值:1)。
- `auto_reinforce`(布尔值,可选):自动强化检索到的记忆(默认值:false)。
- `min_intersection`(数字,可选):最小的提示交集计数要求(默认值:0)。
- `explain`(布尔值,可选):在结果中包含评分解释数据(默认值:false)。
- `trace_timing`(布尔值,可选):包含 v0.7 时间诊断。
- `disable_salience_bias`(布尔值,可选):禁用显著性评分偏差。
- `disable_alias_expansion`(布尔值,可选):在查询期间禁用词典同义词注入(默认值:true)。
- `cuepacks`(字符串[],可选):在查询意图扩展过程中应用的 CuePack 名称。
- `parent_fusion`(`off` | `auto` | `force`,可选):块父融合模式。
- `ordered_reconstruction`(`off` | `auto` | `force`,可选):有序会话重建模式。
- `evidence_coverage`(`off` | `auto` | `force`,可选):多证据覆盖模式。
- `disable_cuebridge_artifacts`(布尔值,可选):禁用 CueBridge 伪影扩展。
- `cuebridge_gap_limit`(数字,可选):最大 CueBridge 间隙扩展。
## 许可证
MIT - 请参阅 [LICENSE](LICENSE) 文件以获取更多详细信息。