Cursor 学习笔记 – Context

Docs: 代码库索引

Fri, 21 Mar 2025 00:00:00 +0000

了解如何在Cursor中索引代码库，以获得更准确的AI帮助和搜索结果

索引代码库

为了获得更好和更准确的代码库答案，您可以索引您的代码库。在幕后，Cursor 为代码库中的每个文件计算嵌入，并将使用这些来提高代码库答案的准确性。

当项目被打开时，每个 Cursor 实例将初始化该工作空间的索引。初始索引设置完成后，Cursor 将自动为添加到您的工作区的任何新文件建立索引，以保持您的代码库上下文最新。

代码库索引的状态位于 Cursor Settings > Features > Codebase Indexing 。

高级设置

默认情况下，Cursor 将索引代码库中的所有文件。

您还可以展开 “Show Settings” 部分以访问更高级的选项。在这里，您可以决定是否要为新存储库启用自动索引，并配置 Cursor 在存储库索引期间将忽略的文件。

Cursor 使用与 VS Code 相同的包来处理文件忽略，这意味着它尊重所有 .gitignore 文件，包括子目录中的文件。您还可以为用户特定的忽略模式创建一个 .cursorignore 文件，您可能希望将其添加到 global.gitignore 中，以避免将其提交到存储库。

如果你的项目中有任何 AI 绝对不需要阅读的大型内容文件，忽略这些文件可以提高答案的准确性。

使用大型单体仓库

在处理包含数十万个文件的大型单体仓库时，重要的是要对索引的内容进行战略性的考虑。

使用 .cursorignore 让每个开发人员配置他们在单体仓库中工作的文件夹和路径
将 .cursorignore 添加到 global.gitignore

这允许每个开发人员在单体仓库中优化其特定工作区域的索引。

FAQ

我在哪里可以看到我索引的所有代码库？

目前，没有办法看到你索引的所有代码库的列表。您需要手动检查每个项目的索引状态，方法是在 Cursor 中打开项目并检查 Codebase Indexing settings。

如何删除所有代码库？

您可以从 “设置” 中删除 cursor 帐户以删除所有已索引的代码库，也可以从每个项目的“代码库索引”设置中手动删除单个代码库。目前没有办法在不删除帐户的情况下一次性删除所有代码库。

Docs: AI规则

Fri, 21 Mar 2025 00:00:00 +0000

使用 Cursor 中的规则，您可以控制底层模型的行为。您可以将其视为指令和/或LLMs的系统提示。

在 Cursor 内部，我们有两种主要方法来定制 AI 的行为以满足您的需求：

项目规则：特定于项目的规则，存储在 .cursor/rules 目录中。当引用匹配的文件时，它们会自动包含在内。
全局规则: 规则全局应用于所有项目，在 Cursor Settings > General > Rules 部分中进行配置。

在以下部分中了解有关如何使用它们的更多信息。

项目规则（推荐）

项目规则提供了一个强大而灵活的系统，具有特定于路径的配置。项目规则存储在 .cursor/rules 目录中，并在项目的不同部分提供对 AI 行为的粒度控制。

它们是这样工作的

语义描述：每个规则都可以包括一个关于何时应用它的描述
文件模式匹配：使用 glob 模式指定规则适用于哪些文件/文件夹
自动附加：引用匹配文件时可以自动包含规则
以使用@file引用规则文件，允许您将多个规则链接在一起

注意

您可以使用@file引用规则文件，允许您将多个规则链接在一起

您可以使用命令面板通过 ctrl + Shift + P > New Cursor Rule 创建新规则。通过使用项目规则，您还可以获得版本控制的好处，因为它只是一个文件

示例用例：

针对某些文件类型的特定于框架的规则（例如，.tsx 文件的 SolidJS 首选项）
自动生成文件的特殊处理（例如，.proto文件）
自定义UI开发模式
特定文件夹的代码样式和架构首选项

全局规则

全局规则可以通过修改 Cursor Settings > General > Rules for AI 下的 AI 规则部分来添加。如果你想指定每个项目都应该包含的规则，比如输出语言、响应长度等，这很有用。

.cursorrules

为了向后兼容，您仍然可以在项目的根目录中使用 .cursorrules 文件。我们最终将在未来删除 .cursorrules，因此我们建议迁移到新的项目规则系统，以获得更好的灵活性和控制。

Docs: @符号

Fri, 21 Mar 2025 00:00:00 +0000

Docs: 忽略文件

Fri, 28 Mar 2025 00:00:00 +0000

概述

Cursor 提供了两个不同的忽略文件来控制文件的处理方式：

.cursorignore：尽最大努力从 AI 功能和索引中排除文件
.cursorindexingignore：仅控制为搜索和上下文索引哪些文件（与旧的 .cursorignore 相同）

.cursorignore

.cursorignore 文件会尽最大努力将文件从 AI 功能和索引中排除。这对于以下情况很有用：

试图从 AI 访问和索引中排除敏感文件
排除包含机密的配置文件
限制对专有代码的访问

.cursorignore 中列出的文件将以最佳方式从 Cursor 的 AI 功能中排除：

不包含在标签页和聊天请求中
未包含在 AI 功能的上下文中
未为搜索或上下文功能编制索引
通过@-symbols 或其他上下文工具不可用

.cursorindexingignore

.cursorindexingignore 文件仅控制为搜索和上下文功能索引哪些文件。这提供了与旧的 .cursorignore 相同的索引控件。当您需要执行以下操作时，请使用此文件：

从索引中删除生成的大型文件
跳过二进制文件的索引
控制代码库的哪些部分可搜索
优化索引性能

重要提示：.cursorindexingignore 中的文件仍然可以作为上下文手动包含或通过 AI 功能访问-它们不会自动索引或包含在搜索结果中。

默认索引忽略文件

仅对于索引，除了在 .gitignore、.cursorignore 和 .cursorindexignore 文件中指定的文件外，默认情况下还忽略以下文件。请注意，这些默认文件仅适用于索引，而不适用于其他 AI 功能。

package-lock.json
pnpm-lock.yaml
yarn.lock
composer.lock
Gemfile.lock
bun.lockb
.env*
.git/
.svn/
.hg/
*.lock
*.bak
*.tmp
*.bin
*.exe
*.dll
*.so
*.lockb
*.qwoff
*.isl
*.csv
*.pdf
*.doc
*.doc
*.xls
*.xlsx
*.ppt
*.pptx
*.odt
*.ods
*.odp
*.odg
*.odf
*.sxw
*.sxc
*.sxi
*.sxd
*.sdc
*.jpg
*.jpeg
*.png
*.gif
*.bmp
*.tif
*.mp3
*.wav
*.wma
*.ogg
*.flac
*.aac
*.mp4
*.mov
*.wmv
*.flv
*.avi
*.zip
*.tar
*.gz
*.7z
*.rar
*.tgz
*.dmg
*.iso
*.cue
*.mdf
*.mds
*.vcd
*.toast
*.img
*.apk
*.msi
*.cab
*.tar.gz
*.tar.xz
*.tar.bz2
*.tar.lzma
*.tar.Z
*.tar.sz
*.lzma
*.ttf
*.otf
*.pak
*.woff
*.woff2
*.eot
*.webp
*.vsix
*.rmeta
*.rlib
*.parquet
*.svg
.egg-info/
.venv/
node_modules/
__pycache__/
.next/
.nuxt/
.cache/
.sass-cache/
.gradle/
.DS_Store/
.ipynb_checkpoints/
.pytest_cache/
.mypy_cache/
.tox/
.git/
.hg/
.svn/
.bzr/
.lock-wscript/
.Python/
.jupyter/
.history/
.yarn/
.yarn-cache/
.eslintcache/
.parcel-cache/
.cache-loader/
.nyc_output/
.node_repl_history/
.pnp.js/
.pnp/

文件格式

这两个文件使用与 .gitignore 相同的语法。以下是一些示例：

基本模式

# Ignore all files in the `dist` directory
dist/

# Ignore all `.log` files
*.log

# Ignore specific file `config.json`
config.json

高级模式

只在 app 目录中包含 *.py 文件：

# ignore everything
*
# do not ignore app
!app/
# do not ignore directories inside app
!app/*/
!app/**/*/
# don't ignore python files
!*.py

故障排查

ignore 文件的语法完全遵循 .gitignore。如果您遇到问题：

在搜索查询中将 “cursorignore” 替换为 “gitignore”
为类似模式检查 Stack Overflow
使用 git check-ignore -v [file] 测试模式以了解匹配

常见问题：

模式相对于 ignore 文件位置进行匹配
后来的模式覆盖了以前的模式
目录模式需要一个尾随斜杠
否定模式（！）必须否定以前的模式

Docs: 模型上下文协议

Fri, 28 Mar 2025 00:00:00 +0000

什么是 MCP？

模型上下文协议（Model Context Protocol / MCP）是一个开放的协议，它描述了应用程序如何向 LLMs 提供上下文和工具。可以将 MCP 看作 Cursor 的插件系统-它允许您通过标准化接口将 Agent 连接到各种数据源和工具，从而扩展 Agent 的功能。

要了解有关 MCP 的更多信息，请访问官方 MCP 文档，深入了解协议：

https://modelcontextprotocol.io/introduction

使用

MCP 允许您将 Cursor 连接到外部系统和数据源。这意味着您可以将 Cursor 与现有的工具和基础设施集成，而不必在代码本身之外告诉 Cursor 项目的结构。

MCP 服务器可以用任何可以打印到标准输出或服务于 HTTP 端点的语言编写。这种灵活性允许您使用首选的编程语言和技术堆栈非常快速地实现 MCP 服务器。

示例

数据库: 允许 Cursor 直接查询数据库，而不是手动输入模式或自己操作数据。
notion: 从 notion 中读取数据以引导 cursor 实现功能
GitHub: 让 Cursor 创建 PR、创建分支、查找代码等
Memory: 允许 cursor 在您工作时记住和调用信息
Stripe: 允许 Cursor 创建客户、管理订阅等

疑问：这些 example 在哪里啊？没有链接

架构

MCP 服务器是通过标准化协议公开特定功能的轻量级程序。它们充当 cursor 和外部工具或数据源之间的中介。

cursor 支持 MCP 服务器的两种传输类型：

stdio Transport
- 在本地计算机上安装
- 由光标自动管理
- 通过标准输出直接通信
- 仅限您在本地访问
输入：Cursor 自动运行的有效 shell 命令

对于 stdio 服务器，该命令应该是 Cursor 可以运行的有效 shell 命令。
SSE Transport
- 可以在本地或远程运行
- 由您管理和运营
- 通过网络进行通信
- 可以跨机器共享
输入：指向 Cursor 外部 MCP 服务器的 /sse 端点的 URL

对于 SSE 服务器，URL 应该是 SSE 端点的 URL，例如 http://example.com:8000/sse。

每种传输类型都有不同的用例，stdio 对于本地开发来说更简单，而 SSE 为分布式团队提供了更大的灵活性。

配置 MCP 服务器

MCP 配置文件使用 JSON 格式，结构如下：

// 该示例演示了使用 stdio 格式的 MCP 服务器
// Cursor 会自动为您运行该进程 
// 该示例使用 Node.js 服务器，使用 `npx` 运行
{
  "mcpServers": {
    "server-name": {
      "command": "npx",
      "args": ["-y", "mcp-server"],
      "env": {
        "API_KEY": "value"
      }
    }
  }
}

// 本例演示了使用 stdio 格式的 MCP 服务器
// Cursor 会自动为您运行该进程
// 该示例使用 Python 服务器，用 `python` 运行
{
  "mcpServers": {
    "server-name": {
      "command": "npx",
      "args": ["-y", "mcp-server"],
      "env": {
        "API_KEY": "value"
      }
    }
  }
}

// 本例演示了使用 SSE 格式的 MCP 服务器
// 用户应手动设置和运行服务器
// 可以联网，让其他人也能访问它
{
  "mcpServers": {
    "server-name": {
      "url": "http://localhost:3000/sse",
      "env": {
        "API_KEY": "value"
      }
    }
  }
}

env 字段允许您指定 MCP 服务器进程可用的环境变量。这对于管理 API 密钥和其他敏感配置特别有用。

配置位置

您可以将此配置放置在两个位置，具体取决于您的用例：

项目配置

对于特定于项目的工具，请在项目目录中创建 .cursor/mcp.json 文件。这允许您定义仅在特定项目中可用的 MCP 服务器。
全局配置

对于要在所有项目中使用的工具，请在 home 目录中创建一个 ~/.cursor/mcp.json 文件。这使得 MCP 服务器在您的所有 Cursor 中可用。

在 Agent 中使用 MCP 工具

Composer Agent 将自动使用 MCP 设置页面上的可用工具下列出的任何 MCP 工具（如果确定它们相关）。要有意地提示工具的使用，只需告诉代理使用该工具，通过名称或描述来引用它。

工具批准

默认情况下，当代 agent 要使用 MCP 工具时，它将显示一条消息，要求您批准。您可以使用工具名称旁边的箭头展开消息，并查看 agent 使用哪些参数调用工具。

Yolo 模式

您可以启用 Yolo 模式，以允许 agent 自动运行 MCP 工具，而无需批准，类似于终端命令的执行方式。阅读更多关于 Yolo 模式和如何启用它在这里 .

工具响应

当使用工具时，cursor 将在聊天中显示响应。此图像显示了示例工具的响应，以及工具调用参数和工具调用响应的扩展视图。

限制

MCP 是一个非常新的协议，仍处于积极的发展中。有一些已知的警告要注意：

工具数量：一些 MCP 服务器，或用户与许多 MCP 服务器活动，可能有许多工具可供 cursor 使用。目前，Cursor 只会将前 40 个工具发送给 agent。
远程开发： Cursor 直接从本地机器与 MCP 服务器通信，可以直接通过 stdio 或使用 sse 通过网络。因此，当通过 SSH 或其他开发环境访问 Cursor 时，MCP 服务器可能无法正常工作。我们希望在未来的版本中改进这一点。
mcp 资源：MCP 服务器提供两种主要功能：工具和资源。今天，Cursor 中提供了工具，允许 Cursor 执行 MCP 服务器提供的工具，并在其后续步骤中使用输出。但是，Cursor 中还不支持资源。我们希望在未来的版本中添加资源支持。