跳到主要内容

为什么文档至关重要

文档提供最新、准确的上下文。没有文档，模型只能依赖过时或不完整的训练数据。文档能帮助模型理解以下关键信息：

  • 当前 API 及其参数
  • 最佳实践方案
  • 组织规范约定
  • 领域专业术语

以及更多重要内容。继续阅读了解如何直接在 Cursor 中使用文档功能，无需切换上下文环境。

模型的知识截止日期

大型语言模型的训练数据存在时间上限，这个时间点被称为"知识截止日期"。这意味着：

  • 可能无法反映最新的库更新
  • 新框架或工具可能未被识别
  • 截止日期后的 API 变更无法获知
  • 训练后的最佳实践可能已经演进

例如，若某模型的知识截止日期是 2024 年初，即使对于流行框架，它也无法知晓 2024 年末发布的新功能。

如何选择合适工具？

通过以下决策树快速确定最适合您文档需求的解决方案：

自动模式

↑

使用 @Web

@Web 能够实时搜索互联网获取最新信息、技术博客和社区讨论。在以下场景中使用它：

  • 最新教程：社区生成的技术内容和示例
  • 方案对比：不同技术方案的比较文章
  • 近期更新：获取最新发布的功能或公告
  • 多视角分析：问题解决的不同思路

@

@Web latest performance optimizations for React 19

∞

Agent⌘I

Auto

↑

内部文档

内部文档包含 AI 模型在训练过程中从未接触过的组织专属信息，可能包括：

  • 内部 API：定制服务与微服务
  • 公司标准：编码规范、架构模式
  • 专有系统：定制工具、数据库、工作流
  • 领域知识：业务逻辑、合规要求

通过 MCP 访问内部文档

模型上下文协议（Model Context Protocol，MCP）为将私有文档和系统接入 Cursor 提供了标准化方式。MCP 在 Cursor 与内部资源之间充当轻量级中间层。

MCP 的核心价值：

  • 模型无法推测内部规范
  • 定制服务的 API 文档未公开
  • 业务逻辑与领域知识具有组织独特性
  • 合规与安全要求因企业而异

实现原理： MCP 通过以下方式建立上下文关联：

  1. 将内部文档转换为结构化知识图谱
  2. 实时匹配开发者的编码上下文
  3. 动态注入相关文档片段至 AI 推理过程

典型应用场景：

# 当调用内部支付网关 API 时
# MCP 自动注入最新接口文档（中文注释需翻译）
def process_payment(order):
# 调用支付网关 v2 版本（2023 年更新）
response = PaymentGatewayV2.create_charge(
amount=order.total,
currency="CNY",
# 强制使用 TLS 1.3 加密（安全规范第 5.2 条）
security_config=SEC_PROFILE_A
)
return response.status == "SUCCESS"

常见 MCP 集成方案

集成方案访问权限示例
Confluence公司 Confluence 空间架构文档、内部服务 API 规范、编码标准与指南、流程文档
Google Drive共享文档和文件夹需求规格说明书、会议纪要与决策记录、设计文档与需求文档、团队知识库
Notion工作区数据库和页面项目文档、团队维基、知识库、产品需求文档、技术规范文档
自定义内部系统和数据库专有 API、遗留文档系统、定制化知识库、专用工具与工作流

（注：表格格式已完整保留，技术术语根据核心术语表进行规范化处理，品牌名称保留英文原称，中文标点使用全角符号并确保中英文字符间保留半角空格）

自定义解决方案

针对独特需求，您可以构建自定义的 MCP 服务器来实现以下功能：

  • 抓取内部网站或门户数据
  • 连接专有数据库系统
  • 访问自定义文档系统
  • 从内部维基或知识库提取信息

💡 当您构建自定义 MCP 服务器时，还可以向 Cursor 暴露用于更新文档的工具

以下是抓取内部文档的自定义 MCP 服务器示例：

TypeScript

Python

code]:pr-[3rem] [&_pre>code>span.line-highlight]:min-w-[calc(100%+3rem)] [&_pre>code>span.line-diff]:min-w-[calc(100%+3rem)] rounded-[14px] bg-white overflow-auto overflow-x-auto scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-black/15 hover:scrollbar-thumb-black/20 active:scrollbar-thumb-black/20 dark:scrollbar-thumb-white/20 dark:hover:scrollbar-thumb-white/25 dark:active:scrollbar-thumb-white/25" component-part="code-block-root" style="font-variant-ligatures: none; height: 100%;">

import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import TurndownService from "turndown";

// 创建用于抓取内部文档的 MCP 服务器
const server = new McpServer({
name: "internal-docs",
version: "1.0.0"
});

const turndownService = new TurndownService();

// 添加抓取内部文档的工具
server.tool("get

# 保持文档更新

文档内容很容易过时。Cursor 能够根据您的实际代码和开发对话生成并更新文档，帮助您维护最新且实用的技术文档。

# 基于现有代码生成文档

使用 Cursor 直接从您的代码库创建专业文档：

- API 文档
- JSDoc 注释
- README 创建

@

为这个 Express 路由生成 API 文档，包含所有端点、参数和响应格式

∞

智能代理⌘I

自动模式

↑

@

为这个类添加完整的 JSDoc 注释，记录所有方法及其参数

∞

智能代理⌘I

自动模式

Auto

↑

**解决复杂问题后：**

@

将我们关于设置身份验证的对话总结成团队维基的逐步指南

∞

Agent⌘

# 核心要点

- **将文档作为上下文**可使 Cursor 更加准确且与时俱进
- 使用 `@Docs` 调用官方文档，`@Web` 获取社区知识
- **MCP** 架构弥合 Cursor 与内部系统之间的鸿沟
- 通过代码和对话生成文档以保持知识更新
- 结合外部文档与内部知识库实现全面理解

（注：根据中文技术文档惯例，Takeaways 译为"核心要点"更符合语境。翻译过程中严格遵守术语表，保留所有指定英文术语，调整句式结构使其符合中文表达习惯，同时确保 Markdown 格式完整保留。）