Augments MCP Server

通过模型上下文协议（MCP）为Claude Code提供下一代框架文档。退货 类型+散文+实例 具有上下文感知格式 任何 npm包——不仅仅是精心策划的包。

mcp名称：dev.augments/mcp

v7的新增功能

版本7.0 是迄今为止最大的升级——文档优先搜索、4个新工具、BM25索引和生产级可靠性。

快速开始

克劳德代码

# Add the MCP server (runs locally via npx)
claude mcp add -s user augments -- npx -y @augmnt-sh/augments-mcp-server

# Verify configuration
claude mcp list

光标

添加到MCP配置中：

{
  "mcpServers": {
    "augments": {
      "command": "npx",
      "args": ["-y", "@augmnt-sh/augments-mcp-server"]
    }
  }
}

环境变量

集 GITHUB_TOKEN 获取示例和文档时，对于更高的GitHub API速率限制：

{
  "mcpServers": {
    "augments": {
      "command": "npx",
      "args": ["-y", "@augmnt-sh/augments-mcp-server"],
      "env": {
        "GITHUB_TOKEN": "ghp_your_token_here"
      }
    }
  }
}

用法

# Get API context with prose + examples (recommended first tool)
@augments get_api_context query="useEffect cleanup" framework="react"

# Natural language queries work great
@augments get_api_context query="how to use zustand middleware"

# Search for APIs by concept (synonym-aware)
@augments search_apis query="state management"

# Get version info with real breaking changes
@augments get_version_info framework="react" fromVersion="18" toVersion="19"

# Migration guide between versions
@augments get_migration_guide package="next" fromVersion="14" toVersion="15"

# Diagnose an error
@augments diagnose_error error="Objects are not valid as a React child" package="react"

# Compare packages side-by-side
@augments compare_packages packages=["zod", "yup", "joi"]

# Scan project dependencies
@augments scan_project_deps

工具

建筑

flowchart TD
    A["Query: 'how to use useEffect cleanup'"] --> B

    B["Intent Detection → howto
Query Parser → react / useEffect"]

    B --> C["Type Fetcher
CDN racing · npm metadata · @types"]
    B --> D["Doc Fetcher
GitHub API · BM25 search · 25 synonym clusters"]
    B --> E["Example Extractor
GitHub docs · README fallback · Auto-discovery"]

    C --> F["Type Parser
Signatures · Parameters · Related types"]
    D --> G["Doc Search Engine
BM25 indexing · Heading-based chunks · API boost"]

    F --> H["Intent-Driven Formatter (howto)
→ Examples first, prose, brief signature
→ ~500-2000 tokens, 10KB max"]
    G --> H
    E --> H

源结构

src/
├── cli.ts                   # stdio entry point
├── server.ts                # MCP server (8 tools + diagnostics)
├── core/                    # Core modules
│   ├── query-parser.ts      # Parse natural language → framework + concept
│   ├── type-fetcher.ts      # Fetch .d.ts + README from npm/unpkg/jsdelivr
│   ├── type-parser.ts       # Parse TypeScript, extract signatures, synonym search
│   ├── example-extractor.ts # Fetch examples from GitHub docs + auto-discovery
│   ├── version-registry.ts  # npm registry integration + changelog-backed diffs
│   ├── doc-fetcher.ts       # GitHub documentation fetcher
│   ├── doc-search.ts        # BM25 inverted index search engine
│   ├── changelog-fetcher.ts # CHANGELOG.md + GitHub Releases parser
│   ├── type-differ.ts       # .d.ts diff between versions
│   └── error-patterns.ts    # Curated error pattern database
├── tools/v4/                # MCP tools
│   ├── get-api-context.ts   # Primary tool (types + docs + examples)
│   ├── search-apis.ts       # Cross-framework API search
│   ├── get-version-info.ts  # Version comparison
│   ├── get-migration-guide.ts # Cross-version migration guides
│   ├── diagnose-error.ts    # Error diagnosis
│   ├── compare-packages.ts  # Package comparison
│   └── scan-project-deps.ts # Dependency scanner
└── utils/
    ├── logger.ts            # stderr logger
    └── lru-cache.ts         # Generic LRU cache with stats

主要特点

文档优先搜索（v7中的新功能）

像“prisma findMany with pagination”和“zustand create store with middleware”这样的查询现在返回真实的文档内容。BM25搜索引擎通过基于头部的区块对从GitHub获取的文档进行索引，并对API名称进行提升和同义词扩展。

概念同义词

25个同义词集群涵盖了状态、表单、获取、动画、路由、身份验证、缓存、效果、中间件、分页、验证、测试、流式传输、错误处理、数据库、布局、模态、表、上传、实时、部署、i18n、SSR、组件和上下文模式。双向查找意味着“usestate”扩展到“state”集群。

意图感知格式

生产可靠性（v7中的新功能）

• 具有抖动的指数回退 对于npm注册表重试，支持429 Retry After
• CDN断路器 --跳过重复失败的CDN端点（3次失败/5分钟）
• GitHub速率限制 --跟踪剩余配额，用完时跳过提取
• LRU缓存 使用模块对所有缓存进行命中/未命中统计

覆盖

任何npm包

每个npm包都是开箱即用的，不需要管理或配置。Augments通过四层自动解析文档：

1. 文档搜索 --从GitHub仓库获取真实文档，用BM25索引
2. TypeScript类型 --捆绑("types" 在package.json中）或DefinitelyTyped(@types/*)
3. 自动发现文档 --解析npm repository 字段，查找GitHub仓库，探测 docs/ 目录
4. README回退 --从中提取与概念相关的代码块和散文 README.md

这意味着增强功能适用于整个npm生态系统（约250万个包），而不仅仅是一个精心策划的子集。

流行框架的增强结果

22个框架为更丰富的示例策划了文档源：React、Next.js、Vue、Prisma、Zod、Supabase、TanStack Query、tRPC、React Hook Form、Framer Motion、Express、Zustand、Jotai、Drizzle、SWR、Vitest、Playwright、Fastify、Hono、Solid、Svelte、Angular、Redux

桶出口处理

特殊子模块解析：React Hook Form、TanStack Query、Zustand、Jotai、tRPC、Drizzle ORM、Next.js

本地开发

# Clone and install
git clone https://github.com/augmentscode/augments-mcp-server.git
cd augments-mcp-server
npm install

# Build with tsup
npm run build

# Run locally
npm start

# Watch mode
npm run dev

# Run tests
npm test

# Run e2e tests (real network calls)
npm run test:e2e

# Type check
npm run type-check

增强功能与上下文相比如何7

贡献

1. 分叉存储库
2. 创建要素分支： git checkout -b feature/amazing-feature
3. 进行更改
4. 运行测试： npm test
5. 提交拉取请求

许可证

MIT许可证-请参阅 许可证 了解详情。

支持

______________________________________________________________________

专为Claude Code生态系统打造 | 版本7.0.0