Opus MCP

Opus MCP服务器

用于Opus作业操作员API的模型上下文协议（MCP）服务器。此服务器提供了以编程方式与Opus工作流交互的工具，包括作业启动、执行、监控和文件上传。

快速开始：参见 QUICKSTART.md 3分钟设置！\ 安装：参见 安装.md 详细说明\ 分布：参见 分布.md 用于共享选项

特性

• 工作流管理：获取工作流详细信息和模式
• 作业操作：启动、执行和监视作业
• 文件处理：为安全文件上传生成预签名URL
• 监控：检查作业状态、检索结果和查看审核日志

安装

1. 安装依赖项：

npm install

1. 构建项目：

npm run build

1. 设置环境变量：

cp .env.example .env
# Edit .env and add your OPUS_SERVICE_KEY

获取API密钥

1. 导航到Opus平台
2. 点击 我的组织 在顶端
3. 点击 齿轮图标 贵组织名称旁边
4. 选择 API密钥 从设置菜单
5. 点击 +生成API密钥
6. 复制密钥（仅显示一次）并添加到 .env 文件

配置

适用于克劳德桌面

添加到您的Claude Desktop配置文件中：

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json 视窗: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "opus": {
      "command": "node",
      "args": ["/absolute/path/to/function1 hackathon/build/index.js"],
      "env": {
        "OPUS_SERVICE_KEY": "your_service_key_here"
      }
    }
  }
}

对于其他MCP客户端

使用带有环境变量的内置可执行文件：

OPUS_SERVICE_KEY=your_key node build/index.js

可用工具

1.获取工作流详细信息

获取工作流详细信息，包括 jobPayloadSchema 它定义了所需的输入。

参数:

• workflowId （字符串，必填）：Opus中的工作流ID

退货：完整的工作流程细节，包括模式、执行估计和输入要求

2.开始工作

为工作流创建新的作业实例。

参数:

• workflowId （字符串，必填）：工作流ID
• title （字符串，必填）：职位名称
• description （string，必填）：职位描述

退货: jobExecutionId 后续操作所需

3.generate_file_upload_url

为安全文件上传生成预签名URL。

参数:

• fileExtension （string，必填）：带点的文件扩展名（例如。， .pdf, .jpeg, .png, .docx)
• accessScope （字符串，可选）：访问范围- all, user, workspace，或 organization （默认）

退货:

• presignedUrl：用于通过PUT请求上传文件
• fileUrl：在作业执行负载中使用此URL

支持的文件类型：.jpeg、.png、.jpg、.pdf、.docx、.csv、.xls、.xlsx、.txt、.json、.html、.xml

4.执行\_ job

使用填充的输入值执行作业。

参数:

• jobExecutionId （字符串，必填）：发件人 initiate_job 响应
• jobPayloadSchemaInstance （对象，必填）：根据工作流模式结构化的作业输入

示例jobPayloadSchemaInstance:

{
  "workflow_input_we4tej0ly": {
    "value": "API Test Project",
    "type": "str"
  },
  "workflow_input_a0hk6ujuo": {
    "value": 45.8,
    "type": "float"
  },
  "workflow_input_h69vx5i4a": {
    "value": "https://files.opus.com/media/private/uploaded/media_file.pdf",
    "type": "file"
  }
}

5.获取_参数_状态

检查当前作业执行状态。

参数:

• jobExecutionId （string，必填）：作业ID

退货：状态- IN PROGRESS, COMPLETED，或 FAILED

6.get_job_results

从已完成的作业中检索结果。

参数:

• jobExecutionId （string，必填）：作业ID

退货：作业结果，包括输出文件和数据（仅在状态为 COMPLETED)

7.get_job_audit_log

获取作业执行的详细审核日志。

参数:

• jobExecutionId （string，必填）：作业ID

退货：所有系统操作的时间戳日志

工作流示例

1. Get workflow details to understand required inputs
   → get_workflow_details(workflowId: "B9uGJfZ3CFwOdMKH")

2. (If needed) Generate file upload URLs
   → generate_file_upload_url(fileExtension: ".pdf")
   → Upload file to presignedUrl using PUT request

3. Initiate a job
   → initiate_job(workflowId, title, description)
   → Save jobExecutionId

4. Execute the job with inputs
   → execute_job(jobExecutionId, jobPayloadSchemaInstance)

5. Monitor status
   → get_job_status(jobExecutionId)

6. Get results when complete
   → get_job_results(jobExecutionId)

7. (Optional) View audit log
   → get_job_audit_log(jobExecutionId)

发展

开发观察模式：

npm run watch

API 文档

有关API的完整详细信息，请参阅根目录中的markdown文件：

• opus-00-get-workflow-details.md -工作流模式检索
• opus-03-initiate-job.md -作业启动
• opus-04-uploading-files-for-job-inputs.md -文件上传
• opus-05-execute-job.md -作业执行
• opus-06-get-job-execution-status.md -状态监测
• opus-07-get-job-execution-results.md -结果检索
• opus-08-job-audit-log.md -审核日志

基础URL

所有请求均发送至： https://operator.opus.com

故障排除

错误：OPUS_SERVICE_KEY环境变量是必需的

• 确保您的 .env 文件存在正确的密钥，或
• 在MCP客户端配置中设置环境变量

错误：身份验证失败

• 验证您的服务密钥是否有效且未过期
• 检查密钥在Opus中是否具有适当的权限

文件上传问题

• 确保文件扩展名与实际文件类型匹配
• 对预签名的URL使用不带身份验证标头的PUT请求
• 验证Opus文档中的文件大小限制（如果有）

许可证

麻省理工学院