Claude Context

🆕 正在为 Claude Code 寻找持久记忆？ 试试 memsearch Claude Code plugin——一套以 Markdown 为先的记忆系统，让你的 AI Agent 能在不同会话间保留长期记忆。

将整个代码库作为 Claude 的上下文

Claude Context 是一个 MCP 插件，可为 Claude Code 和其他 AI 编码 Agent 添加语义代码搜索功能，让它们深入了解整个代码库。

🧠 将整个代码库作为上下文：Claude Context 使用语义搜索，从数百万行代码中找到所有相关代码。无需多轮探索，搜索结果会直接进入 Claude 的上下文。

💰 适用于大型代码库，经济高效：无需在每次请求时都将整个目录加载到 Claude 中（这会非常昂贵），Claude Context 会将代码库高效地存储在向量数据库中，只在上下文中使用相关代码，从而控制成本。

🚀 演示

Model Context Protocol（MCP）可让你将 Claude Context 集成到喜爱的 AI 编码助手中，例如 Claude Code。

快速开始

前提条件

为 Claude Code 配置 MCP

系统要求：

• Node.js >= 20.0.0

配置

使用命令行界面添加 Claude Context MCP 服务：

claude mcp add claude-context \
  -e OPENAI_API_KEY=sk-your-openai-api-key \
  -e MILVUS_ADDRESS=your-zilliz-cloud-public-endpoint \
  -e MILVUS_TOKEN=your-zilliz-cloud-api-key \
  -- npx @zilliz/claude-context-mcp@latest

有关 MCP 服务管理的更多详情，请参阅 Claude Code MCP 文档。

其他 MCP 客户端配置

# IMPORTANT: the top-level key is `mcp_servers` rather than `mcpServers`.
[mcp_servers.claude-context]
command = "npx"
args = ["@zilliz/claude-context-mcp@latest"]
env = { "OPENAI_API_KEY" = "your-openai-api-key", "MILVUS_TOKEN" = "your-zilliz-cloud-api-key" }
# Optional: override the default 10s startup timeout
startup_timeout_ms = 20000

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["-y", "@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "code-context": {
      "command": "npx",
      "args": ["-y", "@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["-y", "@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["-y", "@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

1. 按下 Cmd/Ctrl Shift P，或前往 Augment 面板中的汉堡菜单
2. 选择 Edit Settings
3. 在 Advanced 下，点击 Edit in settings.json
4. 将服务配置添加到 augment.advanced 对象中的 mcpServers 数组

"augment.advanced": { 
  "mcpServers": [ 
    { 
      "name": "claude-context", 
      "command": "npx", 
      "args": ["-y", "@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  ]
}

{
  "mcpServers": {
    "claude-context": {
      "command": "npx",
      "args": ["@zilliz/claude-context-mcp@latest"],
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
        "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
      }
    }
  }
}

{
    "command": "npx",
    "args": ["@zilliz/claude-context-mcp@latest"],
    "env": {
      "OPENAI_API_KEY": "your-openai-api-key",
      "MILVUS_ADDRESS": "your-zilliz-cloud-public-endpoint",
      "MILVUS_TOKEN": "your-zilliz-cloud-api-key"
    }
}

npx @zilliz/claude-context-mcp@latest

在代码库中使用

1. 打开 Claude Code

   cd your-project-directory
   claude
   

2. 为代码库建立索引：

   Index this codebase
   

3. 检查索引状态：

   Check the indexing status
   

4. 开始搜索：

   Find functions that handle user authentication
   

🎉 就是这么简单！ 现在，你可以在 Claude Code 中进行语义代码搜索了。

环境变量配置

如需了解更详细的 MCP 环境变量配置，请参阅我们的环境变量指南。

使用不同的嵌入模型

如需配置自定义嵌入模型（例如 OpenAI 的 text-embedding-3-large、VoyageAI 的 voyage-code-3），请参阅 MCP 配置示例，其中提供了各个服务提供商的详细设置说明。

文件包含与排除规则

如需详细了解文件包含与排除规则，以及如何自定义这些规则，请参阅我们的文件包含与排除规则。

可用工具

1. index_codebase

为代码库目录建立索引，以便进行混合搜索（BM25 + 稠密向量）。

2. search_code

使用自然语言查询，在已建立索引的代码库中进行混合搜索（BM25 + 稠密向量）。

3. clear_index

清除特定代码库的搜索索引。

4. get_indexing_status

获取代码库当前的索引状态。显示正在建立索引的代码库的进度百分比，以及已建立索引的代码库的完成状态。

📊 评估

我们的受控评估表明，在检索质量相当的情况下，Claude Context MCP 可减少约 40% 的 token 用量。这能在生产环境中显著节省成本和时间。这也意味着，在 token 上下文长度有限的情况下，使用 Claude Context 能获得更好的检索和回答结果。

如需了解详细的评估方法和结果，请参阅 evaluation 目录。

🏗️ 架构

🔧 实现细节

• 🔍 混合代码搜索：提出诸如 “查找处理用户身份验证的函数” 之类的问题，利用先进的混合搜索（BM25 + 密集向量）即时获取相关且上下文丰富的代码。
• 🧠 上下文感知：探索大型代码库，了解代码库不同部分之间的关联，即使代码量达数百万行也不例外。
• ⚡ 增量索引：使用 Merkle 树，仅对已更改的文件重新编制索引。
• 🧩 智能代码分块：通过抽象语法树（AST）分析代码并进行分块。
• 🗄️ 可扩展：集成 Zilliz Cloud，实现可扩展的向量搜索，无论代码库规模有多大。
• 🛠️ 可自定义：配置文件扩展名、忽略规则和嵌入模型。

核心组件

Claude Context 是一个包含三个主要软件包的 monorepo：

• @zilliz/claude-context-core：核心索引引擎，集成嵌入功能和向量数据库
• VSCode Extension：适用于 Visual Studio Code 的语义代码搜索扩展
• @zilliz/claude-context-mcp：用于集成 AI Agent 的模型上下文协议服务

支持的技术

• 嵌入提供商：OpenAI、VoyageAI、Ollama、Gemini
• 向量数据库：Milvus 或 Zilliz Cloud（完全托管的向量数据库即服务）
• 代码分割器：基于 AST 的分割器（支持自动回退）、基于 LangChain 字符的分割器
• 语言：TypeScript、JavaScript、Python、Java、C++、C#、Go、Rust、PHP、Ruby、Swift、Kotlin、Scala、Markdown
• 开发工具：VSCode、模型上下文协议

📦 使用 Claude Context 的其他方式

虽然 MCP 是通过 AI 助手使用 Claude Context 的推荐方式，但你也可以直接使用它，或通过 VSCode 扩展使用。

使用核心软件包构建应用

@zilliz/claude-context-core 软件包提供代码索引和语义搜索的基础功能。

import { Context, MilvusVectorDatabase, OpenAIEmbedding } from '@zilliz/claude-context-core';

// Initialize embedding provider
const embedding = new OpenAIEmbedding({
    apiKey: process.env.OPENAI_API_KEY || 'your-openai-api-key',
    model: 'text-embedding-3-small'
});

// Initialize vector database
const vectorDatabase = new MilvusVectorDatabase({
    address: process.env.MILVUS_ADDRESS || 'your-zilliz-cloud-public-endpoint',
    token: process.env.MILVUS_TOKEN || 'your-zilliz-cloud-api-key'
});

// Create context instance
const context = new Context({
    embedding,
    vectorDatabase
});

// Index your codebase with progress tracking
const stats = await context.indexCodebase('./your-project', (progress) => {
    console.log(`${progress.phase} - ${progress.percentage}%`);
});
console.log(`Indexed ${stats.indexedFiles} files, ${stats.totalChunks} chunks`);

// Perform semantic search
const results = await context.semanticSearch('./your-project', 'vector database operations', 5);
results.forEach(result => {
    console.log(`File: ${result.relativePath}:${result.startLine}-${result.endLine}`);
    console.log(`Score: ${(result.score * 100).toFixed(2)}%`);
    console.log(`Content: ${result.content.substring(0, 100)}...`);
});

VSCode 扩展

将 Claude Context 直接集成到 IDE 中。提供直观的界面，用于语义代码搜索和导航。

1. 直接链接：从 VS Code Marketplace 安装
2. 手动搜索：
   • 在 VSCode 中打开扩展视图（Ctrl+Shift+X，或 Mac 上的 Cmd+Shift+X）
   • 搜索 "Semantic Code Search"
   • 点击 Install

🛠️ 开发

设置开发环境

先决条件

• Node.js 20.x、22.x 或 24.x
• pnpm（推荐的软件包管理器）

跨平台设置

# Clone repository
git clone https://github.com/zilliztech/claude-context.git
cd claude-context

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Start development mode
pnpm dev

Windows 专属设置

在 Windows 上，请确保已准备好：

• Git for Windows，并正确配置行尾符
• 通过官方安装程序或软件包管理器安装的 Node.js
• 全局安装的 pnpm：npm install -g pnpm

# Windows PowerShell/Command Prompt
git clone https://github.com/zilliztech/claude-context.git
cd claude-context

# Configure git line endings (recommended)
git config core.autocrlf false

# Install dependencies
pnpm install

# Build all packages (uses cross-platform scripts)
pnpm build

# Start development mode
pnpm dev

构建

# Build all packages (cross-platform)
pnpm build

# Build specific package
pnpm build:core
pnpm build:vscode
pnpm build:mcp

# Performance benchmarking
pnpm benchmark

Windows 构建说明

• 所有构建脚本均使用 rimraf，兼容跨平台运行
• 已启用构建缓存，以加快后续构建
• 可使用 PowerShell 或命令提示符，两者效果相同

运行示例

# Development with file watching
cd examples/basic-usage
pnpm dev

📖 示例

查看 /examples 目录，了解完整的用法示例：

• 基本用法：简单的索引和搜索示例

❓ 常见问题

常见问题：

• Claude Context 会选择嵌入哪些文件？
• 我可以使用完全本地化的部署方案吗？
• 它支持多个项目／代码库吗？
• Claude Context 与其他编码工具相比如何？

❓ 如需详细解答和更多故障排查技巧，请参阅我们的 常见问题指南。

🔧 遇到问题？ 请参阅我们的故障排查指南，获取分步解决方案。

📚 需要更多帮助？ 请查看我们的完整文档，了解详细指南和故障排查技巧。

🤝 贡献

欢迎贡献！请参阅我们的贡献指南，了解如何开始。

各软件包的贡献指南：

• 核心软件包贡献指南
• MCP 服务贡献指南
• VSCode 扩展贡献指南

🗺️ 路线图

• 基于 AST 的代码分析，提升理解能力
• 支持更多嵌入提供商
• 基于 Agent 的交互式搜索模式
• 改进代码分块策略
• 搜索结果排序优化
• 稳健的 Chrome 扩展

📄 许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

🔗 链接

• GitHub 仓库
• VSCode 市场
• Milvus 文档
• Zilliz Cloud