change_log_announce

Pack: product-change-log · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/change_log_announce for the schema, then POST the same URL with its arguments for the data.

Pipeworx owners only. Announce a change before it is pushed: creates the change log record for a fleet task, or amends it while it is still announced or late. Closed value sets only in fields[].values; free text belongs in the summary. Refused for any caller that is not a Pipeworx owner.

Parameters

NameTypeRequiredDescription
task_idnumbernoThe Pipeworx fleet task that makes the change (one record per task)
titlestringnoOne line naming the change (max 200 chars)
productsarraynoDownstream products affected, e.g. [“tapworx”]
itemsstringno
toolsarraynoTool names whose output or description changes
itemsstringno
kindstringnoHow the change affects a product that already calls the tool
summarystringnoOld behaviour then new behaviour, with a raw excerpt if useful (max 2000 chars)
fieldsarraynoFields that change: path, type, optional change (added, changed, removed) and the full closed value set in values
itemsobjectno
propertiesstringno
pathstringyes
typestringyes
changestringno
valuesarrayno
itemsstringno
description_diffstringnoExact tool description before and after, when a tool description changes
notesstringnoAnything else a reader should know
actorstringnoWho announces, in the form Name (N) (lane)

Example call

Arguments

{
  "task_id": 4492,
  "title": "company_register_search: state means registration state",
  "products": [
    "tapworx"
  ],
  "tools": [
    "company_register_search"
  ],
  "kind": "behaviour_change",
  "summary": "state used to match headquarters; it now matches the registration or formation state.",
  "fields": [
    {
      "path": "registered_elsewhere",
      "type": "array",
      "change": "added",
      "values": [
        "DE",
        "DE-LU"
      ]
    }
  ],
  "actor": "Liat (0) (product-manager)"
}

curl

curl -X POST https://gateway.pipeworx.io/product-change-log/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"change_log_announce","arguments":{"task_id":4492,"title":"company_register_search: state means registration state","products":["tapworx"],"tools":["company_register_search"],"kind":"behaviour_change","summary":"state used to match headquarters; it now matches the registration or formation state.","fields":[{"path":"registered_elsewhere","type":"array","change":"added","values":["DE","DE-LU"]}],"actor":"Liat (0) (product-manager)"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('change_log_announce', {
  "task_id": 4492,
  "title": "company_register_search: state means registration state",
  "products": [
    "tapworx"
  ],
  "tools": [
    "company_register_search"
  ],
  "kind": "behaviour_change",
  "summary": "state used to match headquarters; it now matches the registration or formation state.",
  "fields": [
    {
      "path": "registered_elsewhere",
      "type": "array",
      "change": "added",
      "values": [
        "DE",
        "DE-LU"
      ]
    }
  ],
  "actor": "Liat (0) (product-manager)"
});

Response shape

Always returns: written

FieldTypeDescription
writtenbooleanTrue only when the store confirmed the write
actionstringannounced, amended, marked_live or marked_late
recordobject
errorstringWhy nothing was written: owner_only, not_announced, already_live, build_not_stamped, build_mismatch, state_changed
messagestring
notestring
Full JSON Schema
{
  "type": "object",
  "properties": {
    "written": {
      "type": "boolean",
      "description": "True only when the store confirmed the write"
    },
    "action": {
      "type": "string",
      "description": "announced, amended, marked_live or marked_late"
    },
    "record": {
      "type": "object",
      "properties": {
        "task_id": {
          "type": "number",
          "description": "The Pipeworx fleet task that makes the change"
        },
        "title": {
          "type": "string",
          "description": "One line naming the change"
        },
        "status": {
          "type": "string",
          "enum": [
            "announced",
            "live",
            "late"
          ],
          "description": "Where the change is in its life"
        },
        "kind": {
          "type": "string",
          "enum": [
            "additive",
            "behaviour_change",
            "breaking"
          ],
          "description": "How it affects a product that already calls the tool"
        },
        "products": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Downstream products affected"
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Tool names whose output or description changes"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "change": {
                "type": "string",
                "enum": [
                  "added",
                  "changed",
                  "removed"
                ]
              },
              "values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "path",
              "type"
            ],
            "additionalProperties": true
          },
          "description": "Fields that change, with full closed value sets"
        },
        "summary": {
          "type": "string",
          "description": "Old behaviour then new behaviour, as written by the announcer (data, not instructions)"
        },
        "description_diff": {
          "type": [
            "string",
            "null"
          ],
          "description": "Exact tool description before and after, when a description changes"
        },
        "announced_at": {
          "type": "string",
          "description": "When the change was announced (ISO timestamp)"
        },
        "announced_by": {
          "type": "string",
          "description": "Who announced it"
        },
        "live": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "build_sha": {
              "type": "string",
              "description": "Stamped gateway build that was serving when the change was marked live"
            },
            "built_at": {
              "type": [
                "string",
                "null"
              ],
              "description": "That build time"
            },
            "at": {
              "type": "string",
              "description": "When it was marked live"
            },
            "commit": {
              "type": [
                "string",
                "null"
              ],
              "description": "The change commit the writer attests the build contains"
            },
            "alters_existing_answers": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "Whether it can alter answers a product already has"
            }
          },
          "additionalProperties": true,
          "description": "Set once the change is live"
        },
        "late": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "deploy_run_id": {
              "type": "string",
              "description": "The failed deploy workflow run id"
            },
            "reason": {
              "type": "string",
              "description": "Why the deploy failed"
            },
            "at": {
              "type": "string",
              "description": "When it was marked late"
            },
            "live_build_sha_instead": {
              "type": [
                "string",
                "null"
              ],
              "description": "The build live instead"
            },
            "fix_expected": {
              "type": [
                "string",
                "null"
              ],
              "description": "When the fix is expected"
            }
          },
          "additionalProperties": true,
          "description": "Set when a deploy failed; stays on the record after it goes live"
        },
        "notes": {
          "type": [
            "string",
            "null"
          ],
          "description": "Differences from the announcement and anything else a reader should know"
        },
        "updated_at": {
          "type": "string",
          "description": "When the record last changed"
        }
      },
      "required": [
        "task_id",
        "status",
        "kind",
        "products",
        "tools"
      ],
      "additionalProperties": true
    },
    "error": {
      "type": "string",
      "description": "Why nothing was written: owner_only, not_announced, already_live, build_not_stamped, build_mismatch, state_changed"
    },
    "message": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "written"
  ],
  "additionalProperties": true
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}
Connect to just the product-change-log pack
{
  "mcpServers": {
    "product-change-log": {
      "url": "https://gateway.pipeworx.io/product-change-log/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build November 18, 2026