> ## Documentation Index
> Fetch the complete documentation index at: https://linkly.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 在 GitHub Copilot 中使用 Linkly AI

> 将 Linkly AI 本地知识库集成到 GitHub Copilot，让 AI 编程助手能够搜索和阅读你的私有文档

## 前置条件

* 已安装 [VS Code](https://code.visualstudio.com) 并启用 GitHub Copilot 扩展
* Linkly AI Desktop 已启动，MCP 服务正在运行

## 配置步骤

<Tabs>
  <Tab title="MCP HTTP（推荐）" icon="globe">
    <Steps>
      <Step title="打开命令面板">
        在 VS Code 中，按 `Cmd+Shift+P`（macOS）或 `Ctrl+Shift+P`（Windows），输入 `MCP: Add Server`。
      </Step>

      <Step title="选择 HTTP 类型并填写信息">
        选择 **HTTP or HTTPS endpoint**，填写：

        * URL：`http://127.0.0.1:60606/mcp`
        * Server ID：`linkly-ai`

        选择保存位置（User Settings 全局生效，Workspace Settings 仅对当前项目生效）。
      </Step>
    </Steps>

    也可以直接编辑配置文件，在 `.vscode/mcp.json` 或用户 MCP 配置中添加：

    ```json theme={null}
    {
      "servers": {
        "linkly-ai": {
          "url": "http://127.0.0.1:60606/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="MCP Stdio" icon="terminal">
    需要先[安装 Linkly AI CLI](/docs/zh/use-cli)。

    在 `.vscode/mcp.json` 或用户 MCP 配置中添加：

    ```json theme={null}
    {
      "servers": {
        "linkly-ai": {
          "command": "linkly",
          "args": ["mcp"]
        }
      }
    }
    ```
  </Tab>
</Tabs>

<Tip>
  建议同时安装 [Linkly AI Skills](/docs/zh/use-skills)，教会 AI 助手如何高效地使用
  Linkly AI 的工具，提升搜索和阅读效率。
</Tip>

## 开始使用

配置完成后，在 Copilot Chat（`Cmd+Shift+I`）中直接提问，GitHub Copilot 会自动调用 Linkly AI 的工具。例如：

* "搜索我的文档中关于数据库设计的内容"
* "读一下项目的 API 文档"

## 常见问题

<AccordionGroup>
  <Accordion title="看不到 Linkly AI 工具">
    在命令面板执行 `MCP: List Servers`，确认 linkly-ai 服务器状态为
    Running。如果显示错误，检查 Linkly AI Desktop 是否已启动。
  </Accordion>

  <Accordion title="Workspace 和 User Settings 的区别">
    * **User Settings**：对所有项目生效，适合个人使用 - **Workspace
      Settings**（`.vscode/mcp.json`）：仅对当前项目生效，可提交到 Git 供团队共享
  </Accordion>
</AccordionGroup>