文档

快速开始

  1. 1

    生成密钥

    登录后进入控制台的「Keys」页面,点击「生成密钥」。密钥用于 API 鉴权, 请妥善保存,不要提交到代码仓库。

    前往控制台
  2. 2

    写入 MCP 配置

    在编辑器的 MCP 配置文件中加入以下内容,把 LOCUS_TOKEN 换成上一步生成的密钥。 各编辑器的配置文件位置见 集成页面。

    mcp.json
    {
      "mcpServers": {
        "locus": {
          "command": "npx",
          "args": ["-y", "locus-code-mcp"],
          "env": {
            "LOCUS_BASE_URL": "https://ace.panrun.me/relay",
            "LOCUS_TOKEN": "<控制台生成的密钥>"
          }
        }
      }
    }
  3. 3

    开始检索

    重启编辑器后,AI 助手就可以调用 locus_mcp_search 工具, 用自然语言检索你的代码库。首次请求成功后,可以在控制台的「请求日志」里看到记录。

常见问题

MCP 和 Skill 该选哪个?

两者用的是同一套检索引擎和同一个 API,结果没有差别。编辑器支持 MCP 协议就用 MCP,跨平台可用; 想省掉 MCP 服务器配置、并且在 Windows 上使用,就用 Skill——密钥存在系统凭据管理器里,不落到配置文件。 两种方式可以同时装,互不影响。

额度怎么计算?

每个账号每天有固定的检索次数额度,鉴权失败的请求不消耗额度。剩余额度在控制台总览页实时显示。 MCP 与 Skill 共用同一份账号额度。

密钥泄露了怎么办?

在控制台「Keys」页面轮换密钥,旧密钥会立即失效。 使用 Skill 时,再执行一次 auth set-key 更新本地凭据。

检索请求经过哪些环节?

本地 locus-code-mcp 客户端负责目录树、本地 rg/读文件和多轮检索;请求经 Locus API 做鉴权与计费后转发到上游模型,结果再流式返回。

怎样更快更准?

大仓请把检索范围收窄到子包(例如 packages/api),而不是整个 monorepo 根目录。 JS/TS 项目可先建本地符号索引以提升命中:在项目里执行 graph 索引后,客户端会自动用 graph 候选引导检索。 简单问题用较少轮次(max_turns=1~2),跨模块链路追踪再加到 3~5。