> ## 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.

# 在 Claude Code 中使用 Linkly AI

> 将 Linkly AI 本地知识库集成到 Claude Code，为 AI 编程助手提供文档搜索和阅读能力

## 可以用来做什么

<AccordionGroup>
  <Accordion title="让 AI 先读设计文档再写代码">
    在终端中用 Linkly AI 的 `search` 工具检索架构决策记录，再用 `read`
    读取具体规范，Claude Code
    了解项目约定后再动手写代码，减少风格不一致或违反设计原则的情况。
  </Accordion>

  <Accordion title="追溯历史决策，避免重复踩坑">
    快速用 Linkly AI 找到「为什么这么设计」的记录，AI
    理解历史背景后给出的建议更贴合实际情况，而不是给你一个脱离上下文的通用方案。
  </Accordion>

  <Accordion title="在命令行工作流中无缝引用文档">
    无需离开终端，直接在 Claude Code 对话中通过 Linkly AI 的 `search`
    工具搜索计算机中的需求文档和 API 规范，保持专注，不被频繁切换窗口打断。
  </Accordion>
</AccordionGroup>

## 前置条件

* 已安装 [Claude Code](https://claude.ai/code)
* Linkly AI Desktop 已启动，MCP 服务正在运行

## 配置步骤

<Tabs>
  <Tab title="MCP HTTP（推荐）" icon="globe">
    在终端中运行：

    ```bash theme={null}
    claude mcp add --transport http linkly-ai http://127.0.0.1:60606/mcp
    ```
  </Tab>

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

    ```bash theme={null}
    claude mcp add linkly-ai -- linkly mcp
    ```
  </Tab>

  <Tab title="CLI" icon="square-terminal">
    需要先[安装 Linkly AI CLI](/docs/zh/use-cli)。安装后，Claude Code 可以直接调用 CLI 命令来搜索和阅读你的文档：

    ```bash theme={null}
    linkly search "关键词"
    linkly read <document-id>
    ```
  </Tab>
</Tabs>

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

## 验证连接

添加成功后，在 Claude Code 中发送以下提示词验证：

```
搜索我的文档中关于项目设计的内容
```

如果配置正确，Claude Code 会调用 Linkly AI 的 `search` 工具并返回搜索结果。

## 常见问题

<AccordionGroup>
  <Accordion title="HTTP 方式连接失败">
    请检查 Linkly AI Desktop 是否已启动，MCP 服务是否正在运行。可在终端运行
    `curl http://127.0.0.1:60606/mcp` 测试连通性。
  </Accordion>

  <Accordion title="Stdio 方式提示找不到 linkly 命令">
    请确保已[安装 Linkly AI CLI](/docs/zh/use-cli)，并且 `linkly` 命令在 PATH
    中可用。
  </Accordion>
</AccordionGroup>