使用说明

项目简介

MCP Threejs Server 旨在弥合AI助手(如Claude)与Three.js 3D场景创建之间的鸿沟。它作为一个MCP服务器,允许AI助手通过自然语言查询在Sketchfab上搜索可下载的3D模型,并获取模型信息和下载链接,从而简化了在Three.js应用中集成高质量3D资源的过程。

主要功能点

  • 3D模型搜索: 通过自然语言查询在Sketchfab上搜索Three.js兼容的3D模型。
  • 可下载模型过滤: 仅返回Sketchfab上可供下载的模型资源。
  • 模型格式信息: 提供模型的多种格式信息和文件大小,方便选择合适的资源。
  • GLTF模型URL: 对于支持的模型,可以获取直接可用的GLTF格式模型URL,无需手动下载。
  • OAuth2 认证: 使用OAuth2进行Sketchfab API认证,安全可靠,支持自动token刷新。
  • 凭据持久化: 支持本地存储Sketchfab OAuth2凭据,避免重复配置。

安装步骤

方法一:使用 pip 安装

pip install mcp-server-threejs

方法二:使用 Docker 镜像

  1. 拉取 Docker 镜像:
    docker pull buryhuang/mcp-server-threejs:latest

服务器配置

为了使 Claude Desktop 等 MCP 客户端能够连接到 MCP Threejs Server,您需要在客户端中配置服务器信息。以下是 Claude Desktop 的 MCP 服务器配置示例,您需要根据您的 Sketchfab 开发者应用信息进行相应配置:

{
  "mcpServers": {
    "threejs": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "SKETCHFAB_ACCESS_TOKEN=您的 Sketchfab 访问令牌",
        "-e",
        "SKETCHFAB_REFRESH_TOKEN=您的 Sketchfab 刷新令牌",
        "-e",
        "SKETCHFAB_CLIENT_ID=您的 Sketchfab 客户端 ID",
        "-e",
        "SKETCHFAB_CLIENT_SECRET=您的 Sketchfab 客户端密钥",
        "-v",
        "~/.sketchfab_credentials.json:/root/.sketchfab_credentials.json",
        "buryhuang/mcp-server-threejs:latest"
      ]
    }
  }
}

配置参数说明:

  • server name: 'threejs' (服务器名称,在Claude Desktop中用于标识)
  • command: 'docker' (服务器启动命令,这里使用 Docker 运行)
  • args: 启动参数列表,包括:
    • 'run -i --rm': Docker 运行参数,'-i' 保持STDIN开放, '--rm' 容器退出后自动删除。
    • '-e SKETCHFAB_ACCESS_TOKEN=...': 设置 Sketchfab 访问令牌环境变量。 [请替换为您的 Sketchfab 访问令牌]
    • '-e SKETCHFAB_REFRESH_TOKEN=...': 设置 Sketchfab 刷新令牌环境变量。 [请替换为您的 Sketchfab 刷新令牌]
    • '-e SKETCHFAB_CLIENT_ID=...': 设置 Sketchfab 客户端 ID 环境变量。 [请替换为您的 Sketchfab 客户端 ID]
    • '-e SKETCHFAB_CLIENT_SECRET=...': 设置 Sketchfab 客户端密钥环境变量。 [请替换为您的 Sketchfab 客户端密钥]
    • '-v ~/.sketchfab_credentials.json:/root/.sketchfab_credentials.json': 将本地 Sketchfab 凭据文件挂载到容器中,实现凭据持久化。
    • 'buryhuang/mcp-server-threejs:latest': 使用的 Docker 镜像名称和标签。

如果您选择使用 pip 安装,则需要修改 'command' 和 'args' 为 Python 模块运行方式。 详细配置请参考仓库 README 文档。

基本使用方法

配置完成后,在 Claude Desktop 等 MCP 客户端中,您可以使用自然语言指令调用 MCP Threejs Server 的功能。

示例指令:

  • “查找可下载的汽车模型”
  • “搜索逼真的人类角色模型”
  • “找到可以下载的低多边形动物模型”
  • “获取 ID 为 abc123 的宇宙飞船模型的 GLTF URL”

MCP Threejs Server 将根据您的指令在 Sketchfab 上搜索模型,并将结果返回给 Claude Desktop,您可以进一步利用这些模型资源进行 Three.js 项目的创作。

信息

分类

网页与API