Ibm Odm Authoring MCP Server

IBM ODM管理MCP服务器文档（BETA）

概述

IBM ODM管理MCP服务器将IBM ODM管理REST API与现代AI助手和编排平台连接起来。 它使您能够：

• 作为AI助手的工具公开

- 决策中心REST API - 决策服务器REST API（又称RES控制台）

• 与Watson Orchestrate、Claude Desktop、IBM Bob等轻松集成。..

特性

• 工具集成： 将ODM决策中心和决策服务器控制台REST API端点作为工具公开
• 身份验证： Zen API密钥、基本验证和OpenID连接
• 多平台： 与Watson Orchestrate、Claude Desktop合作。..

快速入门

检查 Claude桌面集成指南 有关在中设置和使用管理MCP服务器的详细说明 克劳德桌面版.

或者检查 IBM Bob集成指南 有关在中设置和使用管理MCP服务器的详细说明 IBM Bob.

演示视频

观看我们的演示视频，了解Claude Desktop集成的实际情况：

https://github.com/user-attachments/assets/26c038a2-d650-47c5-a09e-4c1da62c578e

先决条件和安装

• Python 3.13或更高版本 -此MCP服务器是用Python编写的，需要Python 3.13或更高版本
• 紫外线 -一个快速的Python包安装程序和解析器
• Git -开源分布式版本控制系统

请在中找到安装必备组件的说明 Claude桌面集成指南-（步骤1）.

配置

1.ODM容器环境和身份验证

根据您的IBM ODM部署，使用适当的身份验证/授权方法：

1.1. Cloud Pak上的业务自动化ODM

• 环境： 商业自动化云包（CP4BA）

• 身份验证： 用户名和Zen API密钥

1.2. Kubernetes上的ODM

• 环境： 部署在Kubernetes上的IBM ODM（包括OpenShift）
• 身份验证： 3种可能性

1. 基本身份验证：

1. OpenID连接（使用客户端密码）：

1. OpenID连接（使用私钥JWT）：

1.3. 面向开发人员的ODM（Docker/Local）

• 环境： 本地Docker或开发者版

• 身份验证： 基本认证

2.授权

2.1.Cloud Pak上的业务自动化ODM

如果ODM部署在IBM Cloud Pak for Business Automation中，则使用的用户/服务帐户必须分配一个角色，该角色授予以下Zen权限之一：

阅读更多 管理用户权限.

2.2.Kubernetes上的ODM

如果ODM部署在Kubernetes上，则使用的用户/服务帐户必须至少具有以下角色之一：

2.3.云端ODM

如果ODM部署在云端的托管产品ODM中，则使用的用户/服务帐户必须至少分配以下角色之一（适用于合适的环境（开发/测试/生产））：

阅读更多 创建和管理服务帐户.

3.安全连接

3.1.服务器证书

要建立与服务器的SSL/TLS安全连接，管理MCP服务器必须能够访问用于签署服务器证书的证书。

如果使用公共CA证书对服务器证书进行签名，则管理MCP服务器可以在系统受信任的证书中找到它。

如果这是自签名证书，可以指定：

• CLI： --ssl-cert-path
• 环境： SSL_CERT_PATH=

或者，在开发/测试环境中，可以忽略服务器的真实性：

• CLI： --verifyssl "False"
• 环境： VERIFY_SSL="False"

3.2.mTLS（双向TLS）

ODM可以被配置为检查试图建立安全连接的客户端的真实性。

在这种情况下，管理MCP服务器（充当客户端）必须配置私钥及其相关证书（并且服务器必须配置为在建立安全连接时信任提供该证书的客户端）。

可以指定以下参数：

• CLI： `--mtls-key-path

--mtls-cert-path 并且可选 --mtls-key-password ` 如果私钥受密码保护。

• 环境： `MTLS_KEY_PATH=

MTLS_CERT_PATH= 并且可选 MTLS_KEY_PASSWORD= ` 如果私钥受密码保护。

配置参数表

监控MCP服务器的参数 |CLI参数|环境变量|描述|默认值| |--------------|----------------------|-------------|---------| | --log-level | LOG_LEVEL |设置日志记录级别(DEBUG, INFO, WARNING, ERROR, CRITICAL) | INFO | | --traces-dir | TRACES_DIR |存储工具执行跟踪的目录| ~/.ibm-odm-management-mcp-server/traces | | --trace | TRACE |指定要跟踪的内容(EXECUTIONS, EXECUTIONS_WITH_CONTENT, CONFIGURATION) | | --traces-maxsize | TRACES_MAXSIZE |删除最旧痕迹之前要存储的最大痕迹数| 200 |

筛选已发布工具的参数 |CLI参数|环境变量|描述|默认值| |--------------|----------------------|-------------|---------| | --tools | TOOLS |要发布的工具列表（例如decisionServices版本createRelease）。此选项优先于选项--无工具和--标签|| | --no-tools | NO_TOOLS |要忽略的工具列表（例如launchCleanup擦除executeSqlScript）。此选项优先于选项--tags|| | --tags | TAGS |标签列表（例如，关于探索构建）。仅发布属于所列标记的工具。 | |

在远程模式下启动MCP服务器的参数（允许来自远程MCP客户端的连接） |CLI参数|环境变量|描述|默认值| |--------------|----------------------|-------------|---------| | --transport| TRANSPORT | stdio, streamable-http 或 sse ：管理MCP服务器的通信方式：本地(stdio)或远程(streamable-http 或 sse)) | stdio | | --host | HOST |MCP服务器在远程模式下监听的IP或主机名。 | 0.0.0.0 | | --port | PORT |MCP服务器在远程模式下监听的端口。 | 3000 | | --mount-path| MOUNT_PATH |MCP服务器在远程模式下监听的路径。 | /mcp |

MCP服务器配置文件

您可以使用JSON配置文件为Claude Desktop等客户端配置MCP服务器，该文件可以包含环境变量和命令行参数。

提示：

• 使用CLI参数进行快速覆盖或非敏感参数。
• 使用环境变量作为机密。
• 如果需要，您可以混合使用这两种方法。CLI参数覆盖环境变量。

以下是不同类型的部署（开发/测试或生产）、环境（CloudPak等）和用例的一些示例：

• 示例1：基本身份验证
• 示例2：开发人员ODM的基本授权
• 示例3：对于Cloud Pak（Zen API密钥）
• 示例4:OpenID连接
• 示例5:mTLS（双向TLS）身份验证
• 示例6：工具过滤
• 示例7：基于角色的工具筛选
• 示例8：已启用监控

示例1：基本身份验证

下面的示例显示了一个典型的用例，其中敏感信息（此处为密码）作为环境变量传递（这样它就不会显示在进程的参数中），其他参数作为CLI参数传递：

{
  "mcpServers": {
    "ibm-odm-management-mcp-server": {
      "command": "uvx",
      "args": [
        "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
        "ibm-odm-management-mcp-server",
        "--url",     "https://decisioncenter-api-url",
        "--res-url", "https://res-console-url",
        "--ssl-cert-path", "certificate-file",
        "--username", "username"
      ],
      "env": {
        "ODM_PASSWORD": "password"
      }
    }
  }
}

示例2：开发人员ODM的基本授权

对于本地开发和测试，请使用Basic Auth。

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--url",      "http://localhost:9060/decisioncenter-api",
  "--res-url",  "http://localhost:9060/res",
  "--username", "odmAdmin"
],
"env": {
  "ODM_PASSWORD": "odmAdmin"
}

示例3：对于Cloud Pak（Zen API密钥）

对于Cloud Pak上的生产部署，请使用Zen API密钥。

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--url",           "https://decisioncenter-api-url",
  "--res-url",       "https://res-console-url",
  "--ssl-cert-path", "certificate-file",
  "--username",      "USERNAME"
],
"env": {
  "ZENAPIKEY": "ZEN_API_KEY"
}

示例4:OpenID连接

对于Cloud Pak以外的其他环境上的生产部署，如果ODM配置为使用OpenID Connect，则可以使用它。

管理MCP服务器支持以下选项，以对令牌端点和ODM进行身份验证：

• 令牌终结点的客户端身份验证：

- 使用a 客户端密钥 或 - 使用 私钥JWT

• ODM的用户身份验证

- 使用用户的凭据（用户名和密码）（密码授予），或 - 使用客户端服务帐户（客户端凭据授予）

决策中心API的最佳使用方式是使用用户的凭据进行身份验证，以便：

• 用户只能访问他们被允许查看和修改的内容，
• 并且用户的角色被强制执行。

决策服务器API可以使用客户端服务帐户。请注意，如果客户端服务帐户被授予角色（例如。 resDeployer)用户没有的。

1. 使用客户端密码和用户凭据的示例

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--url",           "https://decisioncenter-api-url",
  "--res-url",       "https://res-console-url",
  "--ssl-cert-path", "certificate-file",
  "--token-url",     "https://your-openid-connect_provider-token-endpoint-url",
  "--scope",         "the_scope_to_be_used_if_different_from_default_value_openid"
],
"env": {
  "CLIENT_ID":      "YOUR_CLIENT_ID",
  "CLIENT_SECRET":  "YOUR_CLIENT_SECRET",
  "ODM_USERNAME":   "YOUR_USERNAME",
  "ODM_PASSWORD":   "YOUR_PASSWORD"
}

1. 使用私钥（PKJWT）并使用客户端凭据向决策服务器API进行身份验证的示例

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--res-url",       "https://res-console-url",
  "--ssl-cert-path", "certificate-file",
  "--token-url",     "https://your-openid-connect_provider-token-endpoint-url",
  "--scope",         "the_scope_to_be_used_for_client_credentials"
],
"env": {
  "CLIENT_ID":       "YOUR_CLIENT_ID",
  "PKJWT_KEY_PATH":  "PKJWT_PRIVATE_KEY_FILENAME",
  "PKJWT_CERT_PATH": "PKJWT_CERTIFICATE_FILENAME"
}

示例5:mTLS（双向TLS）身份验证

管理MCP服务器还支持mTLS（双向TLS）身份验证，这进一步保护了SSL连接。

mTLS必须辅以另一种用于授权目的的身份验证/授权方式（以评估访问决策中心的权利），例如下面示例中的基本身份验证：

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--url",           "https://decisioncenter-api-url",
  "--res-url",       "https://res-console-url",
  "--ssl-cert-path", "certificate-file",
  "--username",      "USERNAME_OR_SERVICE_ACCOUNT"
],
"env": {
  "PASSWORD":       "USERNAME_OR_SERVICE_ACCOUNT_PASSWORD",
  "MTLS_KEY_PATH":  "MTLS_PRIVATE_KEY_FILENAME",
  "MTLS_CERT_PATH": "MTLS_CERTIFICATE_FILENAME"
}

示例6：工具过滤

您可能只想发布一部分工具。 以下三个选项可以实现这一目标。 它们可以单独使用或一起使用，在后一种情况下，按以下优先顺序处理：

1. 首先，您可以明确指定要发布的工具

例如，您可以指定仅发布工具 decisionServices （列出决策服务）， decisionService （通过其ID获得决策服务）， testSuites （测试套件列表）， run （运行测试套件）， testreports 和 decisionServicesImport:

   "args": [
     "--tools", "decisionServices", "decisionService", "testSuites", "run", "testreports", "decisionServicesImport"
   ]

此选项优先于以下其他两个选项：如果使用 --tools 选项，无论其他选项的值如何，它都会被发布。

1. 您还可以指定不应发布的工具

例如，您可以发布所有工具，但 wipe, executeSQLScript 和 launchCleanup

   "args": [
     "--no-tools", "wipe", "executeSQLScript", "launchCleanup"
   ]

此选项优先于下一个选项：如果使用 --no-tools 选项，无论其值如何，都不会发布 --tags 选项。

1. 最后，您可以指定应发布的工具的标签

使用时 --tags 选项中，不属于所列标签/类别的工具不会发布。

例如，使用下面的配置，属于标签/类别的决策中心工具 Admin 或 DBAdmin 不会发布：

   "args": [
     "--tags", "About", "Explore", "Manage", "Govern", "Build", "Interchange"
   ]

在 --tools 和 --no-tools 选项、工具由其标识 operationId.

以下是工具列表及其 operationId ODM 9.5.0.1中的标签：

1. 决策中心工具：

1. 决策服务器/RES控制台工具：

示例7：基于角色的工具筛选

某些工具仅限于具有特定角色的用户使用。当管理MCP服务器使用不授予所需角色的凭据时，这些工具会被自动过滤掉。 请参阅上表中的“角色”列，了解每个工具所需的角色。

在下面的示例中（适用于ODM for Developer），定义了两个MCP服务器，每个服务器使用不同的凭据。

• 第一个MCP服务器发布用户可以使用的决策中心工具子集 rtsUser 角色
• 第二MCP服务器发布决策服务器控制台工具的子集，用户可以使用 rtsMonitor 角色

{
  "mcpServers": {
    "ibm-odm-dc-management-mcp-server": {
      "command": "uvx",
      "args": [
        "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
        "ibm-odm-management-mcp-server",
        "--url",     "http://localhost:9060/decisioncenter-api",
        "--username", "rtsUser1"
      ],
      "env": {
        "ODM_PASSWORD": "rtsUser1"
      }
    },
    "ibm-odm-res-management-mcp-server": {
      "command": "uvx",
      "args": [
        "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
        "ibm-odm-management-mcp-server",
        "--res-url",  "http://localhost:9060/res",
        "--username", "resMonitor"
      ],
      "env": {
        "ODM_PASSWORD": "resMonitor"
      }
    }
  }
}

示例8：已启用监控

使用下面的配置，MCP服务器会记录一个名为 --.json 在 ~/.mcp-server-traces 每次运行工具时，都会打开目录。此文件为空。或者，它可以通过替换来存储工具执行的输入和输出 EXECUTIONS 随着 EXECUTIONS_WITH_CONTENT.

"args": [
  "--from", "git+https://github.com/DecisionsDev/ibm-odm-management-mcp-server",
  "ibm-odm-management-mcp-server",
  "--url",      "https://decisioncenter-api-url",
  "--res-url",  "https://res-console-url",
  "--username", "odmAdmin",
  "--trace",    "EXECUTIONS",
  "--traces-dir", "~/.mcp-server-traces"
],
"env": {
  "ODM_PASSWORD": "odmAdmin"
}

通过此配置，一个名为 getToolExecutions 可用于返回工具执行。默认情况下，MCP服务器只保留200次执行（可配置）。达到此限制后，将删除最旧的执行。

此工具可以查询特定工具或特定HTTP响应代码的执行情况。它可以选择检索用于调用工具的输入和返回的输出，前提是这些信息已存储（需要参数 EXECUTIONS_WITH_CONTENT).

您可以向AI代理提出以下问题：

Which tools have been executed the most?

Have users been added or deleted? If so, which ?

Which executions failed and for which reason ?

注意：您还可以让MCP服务器记录一个名为 parsing.json 通过添加以下内容，包含返回给AI代理（用于调试）的工具列表 CONFIGURATION 论点： "--trace", "EXECUTIONS", "CONFIGURATION",.

Docker 镜像

该存储库具有 以便您可以构建一个运行IBM ODM Management MCP服务器的Docker映像，这对于远程运行MCP服务器非常有用。

您可以在 readme。

附加信息

• 有关IBM运营决策管理器（ODM），请参阅 IBM文档.
• 有关IBM Watsonx Orchestrate，请参阅 入门指南.
• 关于Claude Desktop，请参见 克劳德文件.