为什么文档很重要
- 最新的 API 和参数
- 最佳实践
- 团队/组织的约定
- 领域术语
模型知识截止点
- 最近的库更新可能不会体现
- 新出现的框架或工具可能不被认识
- 截止日期之后的 API 变更会被遗漏
- 最佳实践可能在训练后已发生变化
我该用哪种工具?
心智模型
工具 | 心智模型 |
---|---|
@Docs | 就像在浏览和阅读官方文档 |
@Web | 就像在网上搜索解决方案 |
MCP | 就像访问你的内部文档 |
公共文档
使用 @Docs
@Docs
会把 Cursor 连接到主流工具和框架的官方文档。需要最新、权威的信息时就用它,适用于:
- API 参考:函数签名、参数、返回类型
- 入门指南:安装与设置、配置、基础用法
- 最佳实践:官方推荐的模式
- 框架相关调试:官方故障排查指南
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
∞
Agent⌘I
Auto
使用 @Web
@Web
会在实时互联网中搜索最新资讯、博客文章和社区讨论。需要时用它来查找:
- 最新教程:社区产出的内容与示例
- 对比:比较不同方案的文章
- 最新动态:刚发布的更新或公告
- 多元视角:解决问题的不同思路
@
@Web latest performance optimizations for React 19
∞
Agent⌘I
Auto
内部文档
- 内部 API:自定义服务与微服务
- 公司规范:编码约定、架构模式
- 专有系统:自定义工具、数据库、工作流
- 领域知识:业务逻辑、合规要求
使用 MCP 访问内部文档
- 模型无法揣测你的内部约定
- 自定义服务的 API 文档并不公开
- 业务逻辑和领域知识对你的组织来说是独有的
- 合规与安全要求因公司而异
常见 MCP 集成
Integration | Access | Examples |
---|---|---|
Confluence | 公司 Confluence 空间 | 架构文档、内部服务的 API 规范、编码标准与指南、流程文档 |
Google Drive | 共享文档与文件夹 | 规格说明、会议纪要与决策记录、设计文档与需求、团队知识库 |
Notion | 工作区数据库与页面 | 项目文档、团队 wiki、知识库、产品需求、技术规范 |
Custom | 内部系统与数据库 | 专有 API、遗留文档系统、自定义知识库、专项工具与工作流 |
自定义方案
- 抓取内部网站或门户
- 连接专有数据库
- 访问自定义文档系统
- 从内部 wiki 或知识库拉取内容
如果你构建了自定义 MCP 服务器,也可以暴露工具让 Cursor 更新文档
保持文档及时更新
基于现有代码
@
为这个 Express 路由器生成 API 文档,包含所有端点、参数和响应格式
∞
Agent⌘I
Auto
来自聊天会话
在解决复杂问题之后:
@
把我们关于设置身份验证的对话整理成团队 wiki 的分步指南
∞
Agent⌘I
Auto
要点
- 把文档作为上下文能让 Cursor 更准确、更及时
- 用
@Docs
查官方文档,用@Web
获取社区知识 - MCP 架起 Cursor 与你内部系统之间的桥梁
- 从代码和对话生成文档,保持知识最新
- 结合外部与内部文档来源,获得更全面的理解