使用说明

项目简介

avatar-clone-mcp 是一个 MCP 服务器的示例项目，它演示了如何使用 MCP 协议构建一个应用后端，为 LLM 客户端提供工具和资源。该服务器提供了一个简单的头像克隆工具，并包含示例的资源和 Prompt，帮助开发者理解 MCP 服务器的核心概念和使用方法。

主要功能点

工具 (Tools): 提供 'clone_avatar' 工具，允许客户端调用以实现头像克隆功能 (目前 'clone_avatar' 工具的 avatar cloning 逻辑部分待完善，仅为功能演示)。
资源 (Resources): 实现了简单的 Note 存储系统作为资源示例，通过自定义 'note://' URI scheme 访问。每个 Note 资源包含名称、描述和 'text/plain' mimetype。
Prompt 模板 (Prompts): 提供 'summarize-notes' Prompt 模板，用于总结所有存储的 Note，并支持可选的 'style' 参数控制总结的详细程度。
配置示例: 提供了在 Claude Desktop 和 Zed 等 MCP 客户端中配置和使用该 MCP 服务器的详细示例。
多种运行方式: 支持使用 'uv', 'pip', 'docker' 等多种方式运行服务器。
开发和调试: 提供构建、发布和调试 MCP 服务器的指南，包括使用 MCP Inspector 进行调试的说明。

安装步骤

克隆仓库:

git clone https://github.com/Pratik-Kumar-Cse/avatar-clone-mcp.git
cd avatar-clone-mcp

创建虚拟环境 (推荐):

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate  # Windows

运行服务器:

使用 uv (推荐): 无需额外安装，直接使用 'uv run avatar-clone' 命令。
```
uv run avatar-clone
```

使用 pip: 先安装 'avatar-clone' 包，然后使用 'python -m avatar_clone' 命令运行。

pip install avatar-clone
python -m avatar_clone

服务器配置

要使 MCP 客户端（如 Claude Desktop, Zed）连接到 'avatar-clone-mcp' 服务器，需要配置客户端的 MCP 服务器设置。以下是针对 Claude Desktop 的配置示例，其他 MCP 客户端的配置方式类似。

Claude Desktop 配置 (claude_desktop_config.json):

根据不同的运行方式，选择相应的配置添加到 'claude_desktop_config.json' 文件中 ('~/Library/Application\ Support/Claude/claude_desktop_config.json' on MacOS, '%APPDATA%/Claude/claude_desktop_config.json' on Windows)。

使用 uvx (已发布服务器配置示例):

"mcpServers": {
  "avatar-clone": {
    "command": "uvx", // 启动命令，使用 uvx 运行
    "args": [
      "avatar-clone" // 命令参数，运行 avatar-clone 应用
    ]
  }
}

使用 uv (开发/未发布服务器配置示例):

"mcpServers": {
  "avatar-clone": {
    "command": "uv", // 启动命令，使用 uv 运行
    "args": [
      "--directory", // 参数，指定工作目录
      "/path/to/avatar-clone-mcp", //  **[请替换为 avatar-clone-mcp 仓库的实际路径]**
      "run",        // 参数，uv 子命令 run
      "avatar-clone" // 命令参数，运行 avatar-clone 应用
    ]
  }
}

使用 pip 安装 (pip 安装方式配置示例):

"mcpServers": {
  "avatar-clone": {
    "command": "python", // 启动命令，使用 python 解释器
    "args": [
      "-m",           // 参数，以模块方式运行
      "avatar_clone"  // 命令参数，运行 avatar_clone 模块
    ]
  }
}

使用 Docker (Docker 运行方式配置示例):

"mcpServers": {
  "avatar-clone": {
    "command": "docker", // 启动命令，使用 docker
    "args": [
      "run",           // 参数，docker 子命令 run
      "--rm",          // 参数，容器退出后自动删除
      "-i",            // 参数，保持STDIN开放
      "--mount",       // 参数，挂载卷
      "type=bind,src=/Users/username,dst=/Users/username", // **[请替换为你的用户目录，用于容器访问宿主机文件]**
      "avatar-clone"   // 命令参数，运行 avatar-clone Docker 镜像
    ]
  }
}

Zed 配置 (settings.json):

对于 Zed 编辑器，配置在 'settings.json' 文件中。

使用 uvx (Zed 配置示例):

"context_servers": [
  "avatar-clone": {
    "command": {
      "path": "uvx", // 命令路径，使用 uvx
      "args": ["avatar-clone"] // 命令参数，运行 avatar-clone 应用
    }
  }
],

使用 pip 安装 (Zed 配置示例):

"context_servers": {
  "avatar-clone": {
    "command": {
      "path": "python", // 命令路径，使用 python 解释器
      "args": ["-m", "avatar_clone"] // 命令参数，运行 avatar_clone 模块
    }
  },

基本使用方法

启动 'avatar-clone-mcp' 服务器。
在 MCP 客户端 (如 Claude Desktop, Zed) 中配置并连接到 'avatar-clone-mcp' 服务器。
客户端可以列出服务器提供的工具 (例如 'clone_avatar')、资源 (例如 'note://' 资源) 和 Prompt 模板 ('summarize-notes')。
客户端可以调用 'clone_avatar' 工具，并传递 'name', 'image_url', 'platform' 等参数，以请求服务器执行头像克隆操作 (当前工具的 avatar cloning 逻辑部分需要开发者自行完善)。
客户端可以读取 'note://' 资源获取 Note 内容，或使用 'summarize-notes' Prompt 模板生成 Note 总结。

注意: 'clone_avatar' 工具的具体实现需要开发者根据实际需求进行完善。当前仓库提供的代码主要用于演示 MCP 服务器的框架和基本功能。

关键词