使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 应用提供访问 Autodesk Platform Services (APS) 平台数据的能力。通过此 MCP 服务器,LLM 应用可以安全、便捷地获取 Autodesk BIM360 和 Autodesk Construction Cloud (ACC) 中的项目、文档、Issue等信息,从而实现更智能化的 BIM 和建筑行业应用。

主要功能点

  • 连接 Autodesk APS: 通过 Autodesk Secure Service Accounts 安全地访问 APS API。
  • 提供数据访问工具: 内置多种工具,用于检索和获取 BIM360 和 ACC 中的数据,包括:
    • 获取 Autodesk Construction Cloud 账户列表
    • 获取指定账户下的项目列表
    • 获取项目文件夹内容
    • 获取文档版本信息
    • 获取项目 Issue 列表
    • 获取项目 Issue 类型列表
  • MCP 标准协议: 遵循 MCP 协议标准,易于与支持 MCP 协议的 LLM 客户端集成,如 Claude Desktop 和 MCP Inspector。
  • 可扩展性: 工具功能可以方便地扩展,以支持更多 APS API 和数据访问需求。

安装步骤

  1. 环境准备:

  2. 克隆仓库:

    git clone https://github.com/petrbroz/aps-mcp-server.git
    cd aps-mcp-server
  3. 安装依赖:

    yarn install
  4. 构建项目:

    yarn run build
  5. 配置环境变量:

    • 在项目根目录下创建 '.env' 文件。
    • 复制以下内容到 '.env' 文件,并替换为你的 APS 应用凭证和 Service Account 信息(Service Account 的创建方法请参考仓库 README):
      APS_CLIENT_ID=你的APS应用Client ID
      APS_CLIENT_SECRET=你的APS应用Client Secret
      APS_SA_ID=你的Service Account ID
      APS_SA_EMAIL=你的Service Account 邮箱
      APS_SA_KEY_ID=你的Service Account Key ID
      APS_SA_PRIVATE_KEY=你的Service Account 私钥
      注意: Service Account 的创建和配置步骤请务必参考仓库 README 文档中的详细说明。

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以 Claude Desktop 为例,你需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json',添加以下 MCP 服务器配置信息:

{
    "mcpServers": {
        "aps-server": { //  服务器名称,可以自定义,在 Claude Desktop 中用于标识该服务器
            "command": "node", //  启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件
            "args": [
                "/absolute/path/to/aps-mcp-server/build/server.js" //  服务器启动脚本的绝对路径,请替换为你的实际路径
            ]
        }
    }
}

注意: 请将 '/absolute/path/to/aps-mcp-server/build/server.js' 替换为你本地 'aps-mcp-server/build/server.js' 文件的绝对路径

基本使用方法

  1. 启动 MCP 服务器: 当 MCP 客户端(如 Claude Desktop 或 MCP Inspector)尝试连接到 'aps-server' 时,会自动根据配置启动 'build/server.js'。

  2. 在 LLM 客户端中使用:

    • Claude Desktop: 配置完成后,在 Claude Desktop 中即可使用 Prompt 调用 MCP 服务器提供的工具,例如:
      • 'What ACC projects do I have access to?' (我能访问哪些 ACC 项目?)
      • 'Give me a visual dashboard of all issues in project XYZ' (给我项目 XYZ 中所有 Issue 的可视化仪表盘)
    • MCP Inspector: 运行 'yarn run inspect',打开 http://localhost:5173,点击 "Connect" 即可连接并测试 MCP 服务器提供的工具。

提示: 具体可用的 Prompt 和工具功能,请参考仓库中 'src/tools' 目录下的工具定义文件,以及仓库 README 文档中的示例。

信息

分类

商业系统