Skip to content
Back to search

tdoms-mcp

Independent MCP integration for TD/OMS change management.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ashishthomas2202--tdoms-mcp/badge.svg)](/listings/ashishthomas2202--tdoms-mcp)

HTML

<a href="/listings/ashishthomas2202--tdoms-mcp"><img src="/api/listings/ashishthomas2202--tdoms-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

TD/OMS MCP is a command-line MCP server, not an application dependency. Install it globally so local agents can launch the `tdoms-mcp` command:

npm install --global tdoms-mcp
tdoms-mcp ui

To try it without installing it globally:

npx --yes tdoms-mcp@latest ui

Open `http://127.0.0.1:3737`, add a TD/OMS connection, and test it. Credentials and tokens stay in the local TD/OMS MCP data directory and are never returned to agents.

The Agent setup view detects supported MCP clients and can install or update this server after confirmation. Known configuration files are backed up before each change and restored automatically when a client command fails.

Keep TLS verification enabled. Publicly trusted certificates work without configuration. For an internal certificate authority, set the optional CA certificate file in the connection manager or set `TDOMS_MCP_CA_FILE` to an approved PEM file supplied by the organization.

After a global installation, start the compact agent-neutral profile:

tdoms-mcp mcp

The `core` profile keeps the tool list small and reaches every other tool through the catalog; see [Tool Groups](#tool-groups).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 296 lines
  1. # TD/OMS MCP
  2. Standalone TD/OMS change-management MCP for IBM Bob, Codex, Claude-compatible clients, and other agents that can launch a local stdio MCP server. It talks directly to TD/OMS REST APIs and does not require or control the Octo VS Code extension.
  3. This is an independent community project. It is not affiliated with, maintained by, or endorsed by Remain Software, IBM, or their affiliates. TD/OMS, Octo, IBM, IBM i, and IBM Bob are trademarks of their respective owners.
  4. ## Install
  5. TD/OMS MCP is a command-line MCP server, not an application dependency. Install it globally so local agents can launch the `tdoms-mcp` command:
  6. ```shell
  7. npm install --global tdoms-mcp
  8. tdoms-mcp ui
  9. ```
  10. To try it without installing it globally:
  11. ```shell
  12. npx --yes tdoms-mcp@latest ui
  13. ```
  14. Open `http://127.0.0.1:3737`, add a TD/OMS connection, and test it. Credentials and tokens stay in the local TD/OMS MCP data directory and are never returned to agents.
  15. The Agent setup view detects supported MCP clients and can install or update this server after confirmation. Known configuration files are backed up before each change and restored automatically when a client command fails.
  16. Keep TLS verification enabled. Publicly trusted certificates work without configuration. For an internal certificate authority, set the optional CA certificate file in the connection manager or set `TDOMS_MCP_CA_FILE` to an approved PEM file supplied by the organization.
  17. After a global installation, start the compact agent-neutral profile:
  18. ```shell
  19. tdoms-mcp mcp
  20. ```
  21. The `core` profile keeps the tool list small and reaches every other tool through the catalog; see [Tool Groups](#tool-groups).
  22. ## Agent Configuration
  23. Use the same local stdio definition in Bob and JSON-based MCP clients after a global npm installation:
  24. ```json
  25. {
  26. "command": "tdoms-mcp",
  27. "args": ["mcp"],
  28. "env": {
  29. "TDOMS_MCP_PROFILE": "core"
  30. }
  31. }
  32. ```
  33. Codex TOML:
  34. ```toml
  35. [mcp_servers.tdoms]
  36. command = "tdoms-mcp"
  37. args = ["mcp"]
  38. env = { TDOMS_MCP_PROFILE = "core" }
  39. startup_timeout_sec = 20
  40. tool_timeout_sec = 60
  41. ```
  42. Restart or reload the agent's MCP servers after changing the configuration.
  43. ## Agent Skill
  44. The package includes a portable developer skill at `skills/tdoms-mcp-routing`. Its `SKILL.md` teaches agents how to find tools by group; discover site-specific values; perform guarded task, source, compile, checkout, promote, transfer, branch, and approval workflows; and verify final TD/OMS state.
  45. The CLI and local UI can install the complete skill folder for detected IBM Bob, Codex, Claude Code, VS Code Copilot, Kiro, and Gemini CLI installations. The skill contains no credentials, connection profiles, organization-specific values, or personal information. Runtime tool schemas and values returned by the connected TD/OMS server remain authoritative.
  46. List the native skill targets and their installation status:
  47. ```shell
  48. tdoms-mcp skills
  49. ```
  50. Install or update the skill for one agent. User scope makes it available across that agent's projects; workspace scope installs it only in the current project:
  51. ```shell
  52. tdoms-mcp install-skill ibm-bob --scope user --confirm
  53. tdoms-mcp install-skill codex --scope user --confirm
  54. tdoms-mcp install-skill claude-code --scope workspace --confirm
  55. tdoms-mcp install-skill vscode --scope workspace --confirm
  56. tdoms-mcp install-skill kiro --scope user --confirm
  57. tdoms-mcp install-skill gemini-cli --scope user --confirm
  58. ```
  59. Install or update the skill for every detected compatible agent:
  60. ```shell
  61. tdoms-mcp install-detected-skills --scope user --confirm
  62. ```
  63. The Agent Setup page in `tdoms-mcp ui` provides the same actions with User skill and Workspace skill scope controls. Existing skill folders are timestamped and backed up before replacement, concurrent installs are locked, and a failed replacement restores the prior folder. Bob users must enable Advanced mode; existing agent sessions may need to be restarted or reloaded after installation. Claude Desktop chat requires a ZIP upload to **Customize > Skills**; its row provides a correctly packaged download instead of reporting a local folder copy as installed.
  64. The **Codex** row covers the Codex desktop app, CLI, and VS Code extension through `~/.agents/skills`. Restart Codex or reload the VS Code window and start a new task if a newly installed skill is not visible. The **Visual Studio Code** skill action installs for every compatible extension it detects: Codex through `~/.agents/skills`, Claude Code through `~/.claude/skills`, and GitHub Copilot through `~/.copilot/skills`. Use `/skills` in agents that expose that menu, or invoke the skill by name in Codex and Claude Code.
  65. Detect supported local clients from the installed command:
  66. ```shell
  67. tdoms-mcp clients
  68. ```
  69. Install or update one detected client:
  70. ```shell
  71. tdoms-mcp install-client ibm-bob --confirm
  72. tdoms-mcp install-client codex --confirm
  73. tdoms-mcp install-client claude-code --confirm
  74. tdoms-mcp install-client vscode --confirm
  75. ```
  76. Configure every detected client that is not already configured:
  77. ```shell
  78. tdoms-mcp install-detected --confirm
  79. ```
  80. Documented adapters are included for IBM Bob, Codex, Claude Code sessions, Claude Desktop chat, VS Code, Cursor, Windsurf, Kiro, Gemini CLI, Zed, and OpenCode. Microsoft Store Claude installations use the app's virtualized configuration directory automatically.
  81. IBM Bob uses its own global MCP store at `~/.bob/settings/mcp.json`; it does not use VS Code's user-level `mcp.json`. The installer preserves servers from Bob's older `~/.bob/settings/mcp_settings.json` file when creating the current configuration. Bob hot-reloads MCP changes when a workspace folder is open; manage the resulting servers from the MCP tab in the Bob panel settings menu.
  82. Detection and installation are environment-local. Running the installer on Windows configures Windows agents; running it inside WSL configures only that WSL distribution; running it on macOS or Linux uses that platform's native paths. This prevents a Windows client from receiving an unusable WSL command, or the reverse. Claude has two targets: **Claude Code sessions** configures Code sessions opened from Claude Desktop or VS Code, while **Claude Desktop chat** configures regular Desktop chats.
  83. Client installation never copies TD/OMS passwords or tokens into agent configuration. It registers only the local stdio command and the `core` tool profile. Existing files are backed up, writes are atomic, invalid JSON is rejected, and failed client updates are restored.
  84. MCP and skill installation are separate on purpose: the MCP provides live TD/OMS tools, while the skill teaches an agent how to route requests and perform guarded change-management workflows. Install both for the complete experience.
  85. ## Tool Groups
  86. Tools are grouped so an agent loads a small list and still reaches everything. The default `core` profile loads 12 tools:
  87. - `tdoms_list_connections`, `tdoms_get_current_context`, `tdoms_set_working_context`
  88. - `tdoms_list_capabilities`, `tdoms_discover_options`
  89. - `tdoms_plan_workflow`, `tdoms_execute_workflow`, `tdoms_get_workflow_status`
  90. - `tdoms_get_view`
  91. - `tdoms_list_tool_groups`, `tdoms_describe_tools`, `tdoms_run_tool`, `tdoms_run_read_tool`
  92. Every other tool belongs to one of these groups:
  93. | Group | Covers |
  94. | --- | --- |
  95. | `connection` | Saved connections, login, token refresh, Octo sign-in import, system and license info, user context |
  96. | `tasks` | Tasks, task comments and labels |
  97. | `requests` | Requests |
  98. | `objects` | Objects, solutions, components, connection lists, new objects, data areas, IFS objects, object templates |
  99. | `source` | Source and IFS check, read, save, patch and compare |
  100. | `build` | Build queue, compile results and errors, compile overrides, spooled files |
  101. | `transfer` | Checkout, promote, transfer, branches, version conflicts, managed deployments, remote jobs |
  102. | `insight` | Logs, dashboards, impact and dependency analysis, Kanban data, tracker records |
  103. | `admin` | Data dictionary, saved searches, user options, database queries, raw REST access, IBM i data conversions |
  104. An agent calls `tdoms_list_tool_groups`, reads one group with `tdoms_describe_tools`, and calls any tool with `tdoms_run_tool`. Schemas are fetched only for the tools about to be used. `tdoms_run_read_tool` runs only read-only tools and refuses the rest, so clients can let it through without review.
  105. Every tool carries MCP annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`), kept in one table in `src/tool-annotations.js`. Reads are marked read-only; tools that add or update are marked non-destructive; deletes, completions, promotions, transfers, and free-form callers such as `tdoms_call_api` and `tdoms_run_tool` are marked destructive. `tdoms_describe_tools` also reports `readOnly` for each tool.
  106. To load groups as directly callable tools, name them at startup:
  107. ```shell
  108. tdoms-mcp mcp --groups tasks,source
  109. ```
  110. The equivalent environment setting is `TDOMS_MCP_GROUPS=tasks,source`. `tdoms-mcp mcp --profile full` (or `TDOMS_MCP_PROFILE=full`) loads every group; use it only for clients without a tool budget. `tdoms_call_api` in the `admin` group remains an escape hatch for documented endpoints. All tools that can change TD/OMS require explicit confirmation.
  111. ## Working Context And Defaults
  112. Call `tdoms_get_current_context` first. When one connection exists it is selected automatically, and the saved TD/OMS username becomes the default programmer ID.
  113. `tdoms_set_working_context` saves the active connection, application, task, request, environment and transfer path. After that, calls may omit `connectionId`, and tools that require an application or task fall back to the saved values and report them as `defaultsApplied`. The context is stored in the local data directory and shared by every agent on the machine.
  114. ## Signing In
  115. Credentials never pass through agent chat. Use one of:
  116. - `tdoms-mcp ui`: the local control plane page. Add a connection, sign in to IBM i, pick the active connection, sign in to Octo, set up agents and browse the tool groups. It only answers requests addressed to this machine.
  117. - `tdoms-mcp login --host <host> --port <port> --username <user>`: prompts for the password in the terminal, or reads `TDOMS_MCP_PASSWORD` for unattended setup. Nothing is saved unless the sign-in succeeds.
  118. - `tdoms-mcp import-octo --confirm`, or the `tdoms_connection_import_octo` tool: reuses the TD/OMS server and session of the Octo extension when it is signed in on the same machine. Run it without `--confirm` to preview. When the imported token expires, sign in to Octo again and the next call picks up the new token, or save a password with `tdoms-mcp login`.
  119. ### Octo Account (Optional)
  120. TD/OMS tools only need the IBM i connection. Signing in to an Octo server as well is optional and gives access to what that server publishes for your organization, such as its MCP tool definitions and agent skills.
  121. - In `tdoms-mcp ui`, open **Octo sign-in** and enter the organization URL (the address you open Octo with, for example `https://octo.example.com/org/acme`), your username or email and your password. A two-factor code is asked for when the account needs one.
  122. - From a terminal: `tdoms-mcp octo-login --url <organization url> --username <user or email>`. The password comes from a hidden prompt or `TDOMS_MCP_OCTO_PASSWORD`.
  123. - `tdoms-mcp octo-probe` runs a read-only check of what the account can see and prints counts and names only, with no secrets.
  124. - `tdoms-mcp octo-org <organization>` picks the organization when the account belongs to more than one and the URL did not name it. The setup page offers the same choice.
  125. - `tdoms-mcp octo-status` shows the saved account and `tdoms-mcp octo-logout` removes it.
  126. The password is used once and never stored. Only the API key the server returns is kept, encrypted in the local data directory.
  127. ## Discovery And Planned Changes
  128. Use `tdoms_discover_options` for both site-specific choices and structured reads. It supports workflow choices such as environments, programmers, paths, transfer targets, templates, reasons, conflicts, and user options. It also replaces extension views with task, request, component, source, queue, compile, history, log, spool, tracker, dependency, and dashboard reads. Task reads default to the current programmer; pass `context.allUsers: true` only when a broader search is intended.
  129. For a mutation:
  130. 1. Discover the valid choices.
  131. 2. Call `tdoms_plan_workflow` with the chosen context, exact request body, and `optionSelections` keyed by option-set name. Those choices are validated now and before execution.
  132. 3. Review its endpoint/body preview and obtain user approval.
  133. 4. Call `tdoms_execute_workflow` with the returned `planId` and `confirm: true`.
  134. 5. Call `tdoms_get_workflow_status` when the operation is asynchronous.
  135. Linking a task to a tracker issue (`link-task-to-issue`) needs only the task and the issue: pass `issueKey`, `issueUrl`, `issueId`, and `issueTitle` as selections. The plan works out the tracker product id and the issue URL form from the application's existing links and shows them under `defaultsApplied`. If the application uses several tracker products, or none yet, the plan stops and lists the choices; pass `productId` to pick one. The direct `tdoms_task_link_ticket` and `tdoms_task_unlink_ticket` tools take the TD/OMS request fields by name and preview the request until called with `confirm: true`.
  136. Plans expire after ten minutes. Execution re-reads relevant TD/OMS state and rejects stale plans. A plan can execute only once.
  137. ## Views For Apps And Agents
  138. `tdoms_get_view` returns Work Management, Kanban, analytics, dependency graph, build queue and transfer history as UI-neutral data. Each response has a `widget` (`board`, `table`, `stats` or `graph`) that an app renders its own way, and a plain-language `summary` an agent can relay. Cards and rows carry suggested follow-up tool calls. The shapes are documented in [docs/view-models.md](docs/view-models.md).
  139. ## Embedding In An App
  140. The package exports its building blocks, so a desktop app can host the server in-process on any MCP transport:
  141. ```js
  142. import { createMcpServer, ConnectionStore } from "tdoms-mcp";
  143. const server = createMcpServer({ store: new ConnectionStore(), groups: "tasks,source" });
  144. await server.connect(transport);
  145. ```
  146. Apps and agents that cannot launch a local process can use Streamable HTTP:
  147. ```shell
  148. tdoms-mcp http --port 3738
  149. ```
  150. The endpoint is `http://127.0.0.1:3738/mcp`. Every request needs `Authorization: Bearer <token>`; the token comes from `TDOMS_MCP_HTTP_TOKEN` or is generated once into the data directory as `http-token`. The listener refuses non-loopback hosts unless `TDOMS_MCP_HTTP_ALLOW_REMOTE=1` is set, because it serves plain HTTP; put a TLS proxy in front before exposing it.
  151. ## CLI Reference
  152. ```text
  153. tdoms-mcp ui [--port 3737] Open the local connection and agent setup UI
  154. tdoms-mcp stop [--port 3737] Stop the running setup UI
  155. tdoms-mcp clients List detected MCP-capable agents
  156. tdoms-mcp skills List native skill targets and status
  157. tdoms-mcp install-client <id> --confirm Configure one detected agent
  158. tdoms-mcp install-detected --confirm Configure all detected agents
  159. tdoms-mcp install-skill <id> --scope user --confirm
  160. Install a skill for one detected agent
  161. tdoms-mcp install-detected-skills --scope user --confirm
  162. Install skills for all compatible agents
  163. tdoms-mcp mcp Start the core stdio MCP server
  164. tdoms-mcp mcp --groups tasks,source Start core plus the named tool groups
  165. tdoms-mcp mcp --profile full Start with every tool group loaded
  166. tdoms-mcp http [--port 3738] Start the Streamable HTTP MCP server
  167. tdoms-mcp groups List the tool groups
  168. tdoms-mcp login --host ... --username ... Save a connection and sign in from the terminal
  169. tdoms-mcp import-octo --confirm Reuse the Octo extension's signed-in session
  170. tdoms-mcp octo-login --url ... --username ...
  171. Sign in to an Octo server (optional)
  172. tdoms-mcp octo-org <organization> Pick the organization for a multi-organization account
  173. tdoms-mcp octo-probe Read-only check of what the Octo account can see
  174. tdoms-mcp octo-status Show the saved Octo account
  175. tdoms-mcp octo-logout Remove the saved Octo account
  176. tdoms-mcp smoke Check local configuration without connecting
  177. tdoms-mcp secure-storage Harden the local data directory
  178. tdoms-mcp --help Show command help
  179. ```
  180. ## Development
  181. The following commands are only for contributors working from a cloned source repository. They are not required after installing the npm package.
  182. ```shell
  183. npm install
  184. npm test
  185. npm run smoke
  186. npm run ui
  187. ```
  188. Tests use mocked TD/OMS clients and do not mutate a real environment. Live mutation tests must be enabled deliberately against a dedicated test system.
  189. Local profiles are stored under `%APPDATA%/tdoms-mcp` on Windows, `~/Library/Application Support/tdoms-mcp` on macOS, and `~/.config/tdoms-mcp` on Linux. Override this with `TDOMS_MCP_DATA_DIR`.
  190. ## Credential Storage
  191. Connection metadata is stored in `connections.json`. Passwords and refreshed JWTs are encrypted with AES-256-GCM in `secrets.json`. By default, a random key is stored in `local.key`. All three files use atomic replacement and cross-process locking, and POSIX systems enforce `0700` on the directory and `0600` on files.
  192. For stronger key separation, set `TDOMS_MCP_MASTER_KEY` to 32 random bytes encoded as base64 or 64 hexadecimal characters before adding connections. Keep the same value available to every MCP process that uses that data directory. Changing or losing it makes existing encrypted secrets unreadable.
  193. Generate a base64 key:
  194. ```shell
  195. node -e "console.log(require('node:crypto').randomBytes(32).toString('base64'))"
  196. ```
  197. On Windows, restrict an existing data directory to the current user, SYSTEM, and local Administrators:
  198. ```powershell
  199. tdoms-mcp secure-storage
  200. ```
  201. Native WSL uses its own Linux data directory and requires Node.js 18 or newer. To reuse the Windows installation and Windows credentials from WSL, launch Windows `node.exe`; otherwise configure the connection separately inside WSL. Avoid sharing credential files through `/mnt/c` unless the Windows ACL has been hardened.
  202. ## License
  203. Released under the MIT License. See `LICENSE`.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.