使用说明

项目简介

Augments MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的、功能强大的文档检索系统。它为大型语言模型（LLM）客户端（如 Claude Code、Cursor）提供全面、实时的开发框架文档、上下文感知辅助和智能缓存功能，旨在显著提升开发工作流程的效率和准确性。服务器通过标准化的 JSON-RPC 协议进行通信，能够托管和管理各种编程框架的文档资源，执行复杂的工具操作，并提供定制化的LLM交互模式。

主要功能点

全面的框架支持: 覆盖Web、后端、移动、AI/ML、设计等8大类85+框架，支持多来源（GitHub仓库、官方网站）文档聚合，并具备配置热加载能力。
高级缓存系统: 采用基于TTL（生存时间）的多级缓存策略（内存和磁盘），实现智能失效和自动刷新，确保文档的最新性和高性能访问。
上下文增强: 能够组合多个框架的文档以提供多框架上下文，分析代码兼容性，识别常见使用模式和最佳实践，并针对特定开发任务提供定制指导。
丰富的MCP工具: 提供了9个核心MCP工具，涵盖框架发现、文档访问、上下文增强和缓存管理等完整文档生命周期。例如，可以列出所有可用框架、获取特定框架的详细文档、搜索文档内容、获取多框架的整合上下文，甚至分析代码与特定框架的兼容性。
开发者体验优化: 提供结构化的JSON输出，支持异步操作以保证高性能，并具备错误恢复机制。

安装步骤

克隆仓库: 首先，将项目仓库克隆到您的本地计算机：

git clone https://github.com/augmnt/augments-mcp-server.git
cd augments-mcp-server

安装依赖: 推荐使用 'uv' 包管理器安装项目依赖，它通常速度更快：
```
uv sync
```
如果您没有安装 'uv'，也可以使用 'pip' 进行安装：
```
pip install -e .
```

环境配置（可选）: 在项目根目录创建一个名为 '.env' 的文件。您可以在其中配置服务器的缓存目录、用于提高 GitHub API 速率限制的 GitHub Token 以及日志级别等。

# 缓存设置
AUGMENTS_CACHE_DIR=~/.cache/augments-mcp-server

# GitHub API Token (可选，用于更高的速率限制)
GITHUB_TOKEN=your_github_token_here

# 日志级别
LOG_LEVEL=INFO

服务器配置（MCP客户端连接）

MCP 服务器运行后，您的 MCP 客户端（如 Claude Code 或 Cursor）需要配置其连接信息才能与之通信。以下是为 Claude Desktop 配置本地运行的 Augments MCP 服务器的 JSON 配置示例，以及每个字段的说明：

配置信息示例 (JSON 格式):

{
  "mcpServers": {
    "augments-local": {
      "command": "uv",
      "args": ["run", "augments-mcp-server"],
      "cwd": "/path/to/augments-mcp-server",
      "env": {
        "AUGMENTS_CACHE_DIR": "~/.cache/augments-mcp-server",
        "GITHUB_TOKEN": "your_github_token"
      }
    }
  }
}

配置字段说明：

'mcpServers': 这是 MCP 客户端配置中用于定义所有 MCP 服务器的根对象。
'augments-local': 这是您为本地服务器定义的名称，可以根据您的偏好命名。客户端会通过此名称引用该服务器。
'command': 指定用于启动 MCP 服务器进程的命令。在本例中，推荐使用 'uv'，因为它能快速高效地运行 Python 应用。请确保 'uv' 已安装且在系统的 PATH 环境变量中。
'args': 这是一个字符串数组，包含传递给 'command' 命令的参数。'"run", "augments-mcp-server"' 表示运行 'augments-mcp-server' Python 模块。
'cwd': （重要） 指定服务器进程的工作目录。您需要将 '/path/to/augments-mcp-server' 替换为 Augments MCP 服务器项目在您本地文件系统中的实际路径。
'env': 这是一个可选的对象，用于为服务器进程设置环境变量。
- 'AUGMENTS_CACHE_DIR': 定义服务器存储文档缓存的目录。
- 'GITHUB_TOKEN': 提供您的 GitHub Personal Access Token。如果您需要从 GitHub 获取大量文档或达到更高的 API 请求速率限制，这是非常有用的。

配置位置（Claude Desktop 客户端）：

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'
Linux: '~/.config/Claude/claude_desktop_config.json'

将上述 JSON 配置（根据您的实际路径和 Token 进行修改）添加到您的 Claude Desktop 配置文件的 'mcpServers' 部分。保存并重启您的 Claude Desktop 客户端，以加载新的 MCP 服务器。

基本使用方法

一旦服务器配置并运行，您就可以通过 MCP 客户端（如 Claude Code 或 Cursor）使用其提供的工具。

列出Web框架:

@augments list frameworks in the web category

获取 Tailwind CSS 响应式设计文档:

@augments get documentation for tailwindcss responsive design

获取 Next.js、Tailwind CSS 和 Shadcn UI 的多框架上下文（用于构建带暗模式的仪表盘）:

@augments get context for nextjs, tailwindcss, and shadcn-ui for building a dashboard with dark mode

分析 React 组件与 Tailwind CSS 的兼容性:

@augments analyze this React component for tailwindcss compatibility:
[粘贴您的代码]

搜索 Next.js 文档中关于 "app router" 的内容:

@augments search nextjs documentation for "app router"

关键词