# 快速入门

Canonical source: https://maguyva.ai/zh-hans/docs/quickstart

License: text under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/); code samples under [MIT-0](https://opensource.org/license/mit-0); the Maguyva name, logos, brand assets and other code are not covered. Details: [maguyva.ai/license](https://maguyva.ai/license).

从零到得到一个已验证答案的最快路径：获取一个密钥，对一个你已经熟悉的仓库建立索引，连接你的客户端，然后问一个你自己就能判断对错的问题。

## 1. 获取 API 密钥

[免费开始](https://app.maguyva.ai)——无需信用卡。你的 API 密钥（以 `mgv_` 开头）保存在 [app.maguyva.ai](https://app.maguyva.ai)。

## 2. 对一个你已经熟悉的仓库建立索引

从门户网站连接一个 GitHub 仓库，让它完成索引。选一个你能快速核实结果的小仓库——这样一眼就能看出 Maguyva 是否真的在为模型提供依据，而不是一上来就试图把你们公司的所有代码都索引一遍。

## 3. 连接你的客户端

对于 Claude Code，从插件市场安装 Maguyva 插件——在 Claude Code 内运行以下每条命令：

```text
/plugin marketplace add maguyva/agent-plugins
/plugin install maguyva@maguyva
```

该插件会使用 `MAGUYVA_API_KEY` 环境变量中的密钥进行身份验证。请在你的 shell 中设置它（由于密钥是按仓库划分范围的，建议按项目使用 `direnv`）：

```bash
export MAGUYVA_API_KEY="mgv_xxxx"
```

团队使用？在 `/plugin install maguyva@maguyva` 打开的面板中选择 project 范围。插件会被记录到仓库的 `.claude/settings.json` 中，由你提交；每位队友仍需运行一次安装。会话内的 `/plugin` 命令不支持 `--scope` 参数，所以如需用脚本完成，请从仓库根目录运行 shell 形式：

```bash
claude plugin marketplace add maguyva/agent-plugins --scope project
claude plugin install maguyva@maguyva --scope project
```

大多数其他客户端（Cursor、VS Code、Devin Desktop、Zed 等）会直接连接到远程服务器——只需用一个 `Bearer` 请求头指向该端点，无需任何桥接程序。例如，Cursor 的 `.cursor/mcp.json`：

```json
{
  "mcpServers": {
    "maguyva": {
      "url": "https://maguyva.tools/mcp",
      "headers": {
        "Authorization": "Bearer ${env:MAGUYVA_API_KEY}"
      }
    }
  }
}
```

具体格式因客户端而略有不同（VS Code 嵌套在 `servers` 下并使用 `type: "http"`，Antigravity 使用 `serverUrl`，Zed 使用 `context_servers`）。这个 Cursor 示例从上面提到的 `MAGUYVA_API_KEY` 环境变量读取密钥；如果某个客户端的配置里显示的是 `mgv_xxxx` 占位符，就把它替换成你的 API 密钥。然后重启你的客户端。全部 23 个有配置文档的客户端的精确配置，都在 [安装指南](https://maguyva.ai/zh-hans/docs/installation) 中。

## 4. 问一个你自己就能判断对错的问题

先问 **"我连接了哪些仓库？"** 来确认连接是否成功，然后问一个你已经知道答案的、关于你仓库的真实问题——比如 **"这个代码库中的身份验证是如何处理的？"**

你应该会得到带有文件路径和行号的答案。打开引用的文件，检查这个答案在真实仓库面前是否站得住脚。这一个被你验证过的答案，比任何功能列表都更能说明问题——让这个工具先赢得信任，再让它加入你的默认工作流。

没有结果或出现连接错误？请在[故障排查](https://maguyva.ai/zh-hans/docs/troubleshooting)中检查 API 密钥、客户端配置和仓库索引状态。如果使用桥接程序，还请确认 `npx` 可用。

## 后续步骤

- 安装指南: 全部 23 个客户端的具体配置说明
- 工作原理: 从你提出问题到得到答案之间发生了什么
- MCP API 参考: 每个工具，逐参数说明