使用说明

项目简介

Sherpa 是一款代码库助手，让您能够通过大型语言模型 (LLM) 与代码库进行交互。它能够智能地分析代码库，支持多种 LLM，并利用 Model Context Protocol (MCP) 实现安全的文件系统访问和功能扩展。

主要功能点

智能代码分析：能够理解项目结构和内容，智能判断回答代码库问题所需读取的文件。
多种 LLM 支持：支持 Anthropic Claude、Google Gemini 和 OpenAI GPT 系列模型。
完全本地和私有：API 密钥由用户自行提供，所有数据处理均在本地进行，不会上传到外部服务器。
交互式聊天界面：提供用户友好的 Web UI，方便与 Sherpa 进行交互，查看工具使用情况和提供给 LLM 的上下文信息。
聊天记录：对话历史记录存储在本地浏览器，方便随时恢复会话。
安全的文件系统访问：内置基于 MCP 的文件系统服务器，限制对指定目录的访问，防止未授权的文件访问。
Git 支持：支持本地目录和远程 Git 仓库。
MCP 工具支持：可以通过配置 MCP 服务器扩展 Sherpa 的功能。

安装步骤

确保已安装 Node.js 和 npm 或 bun。
打开终端，运行以下命令，将 '<path/to/your/project>' 替换为您的项目路径，或将 '<git_url>' 替换为 Git 仓库 URL：
```
npx @cartographai/sherpa <path/to/your/project>
```
或
```
npx @cartographai/sherpa <git_url>
```
该命令会自动克隆仓库（如果提供的是 Git URL）、启动本地服务器，并在默认浏览器中打开 Sherpa Web 应用 (http://localhost:3031)。
在 Web 应用的设置面板（点击 "Config" 按钮）中，配置您想要使用的 LLM 的 API 密钥（Anthropic, Gemini, 或 OpenAI）。

服务器配置

内置 MCP 文件系统服务器：Sherpa 默认包含一个内置的 MCP 文件系统服务器，用于安全访问您指定的代码库目录。您无需额外配置此服务器。
配置外部 MCP 服务器（可选）：Sherpa 也支持连接到外部 MCP 服务器以扩展功能。要配置外部 MCP 服务器，请创建或编辑 '~/.config/sherpa/mcp_servers.json' 文件，并按照 JSON 格式添加服务器配置信息。

'mcp_servers.json' 配置示例 (参考仓库 README)：

{
  "mcpServers": {
    "memory": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-memory"]
    },
    "time": {
      "command": "uvx",
      "args": ["mcp-server-time", "--local-timezone=Asia/Singapore"]
    },
    "github": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

配置参数说明：

'"server name"': 自定义服务器名称，例如 "memory", "time", "github"。
'"command"': 启动 MCP 服务器的命令，例如 '"npx"', '"uvx"', '"docker"'。
'"args"': 启动命令的参数数组，例如 '["-y", "@modelcontextprotocol/server-memory"]', '["mcp-server-time", "--local-timezone=Asia/Singapore"]', '["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"]'。
'"env"' (可选): 启动服务器所需的环境变量，例如 '{"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"}'。

基本使用方法

完成安装和配置后，在浏览器中打开 Sherpa Web 应用 (http://localhost:3031)。
在聊天界面中，您可以开始向 Sherpa 提问关于代码库的问题。Sherpa 会智能地使用工具来查找相关信息并给出解答。

关键词

使用说明

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息