Skip to main content
Glama

subscription_cancel

DestructiveIdempotent

Stop watching by cancelling one Port OS event subscription using its exact ID from subscription_list or subscription_inspect.

Cancellation is idempotent. Select the intended subscription by name, source endpoint and catalog event; names are not cancellation keys. A stopped monitor requires a new subscription to watch again.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "idempotencyKey": "<idempotencyKey>",
      "ifMatch": "<ifMatch>",
      "id": "<id>"
    },
    "name": "subscription_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesExact subscription ID returned by subscription_list. Never use a display name or endpoint ID.
ifMatchYesExact strong etag from subscription_inspect or subscription_list.
idempotencyKeyYesStable unique key for this write; reuse it only to retry the same request for 24 hours.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / $defs
      Added value: +{
      +  "ErrorCode": {
      +    "enum": [
      +      "BAD_REQUEST",
      +      "UNAUTHORIZED",
      +      "FORBIDDEN",
      +      "INSUFFICIENT_SCOPE",
      +      "NOT_FOUND",
      +      "CONFLICT",
      +      "UNPROCESSABLE_ENTITY",
      +      "UNSUPPORTED_OPERATION",
      +      "TOO_MANY_REQUESTS",
      +      "SERVICE_UNAVAILABLE",
      +      "NOT_IMPLEMENTED",
      +      "INTERNAL",
      +      "CHECKSUM_MISMATCH",
      +      "FILE_TOO_LARGE",
      +      "STORAGE_UNAVAILABLE",
      +      "INSUFFICIENT_PERMISSIONS",
      +      "INVALID_FILE_TYPE",
      +      "QUOTA_EXCEEDED",
      +      "CONCURRENT_MODIFICATION",
      +      "ENDPOINT_UNREACHABLE",
      +      "BRIDGE_UNREACHABLE",
      +      "CLOUD_CONTROL_DISABLED",
      +      "ENDPOINT_BUSY",
      +      "ENDPOINT_LOW_POWER",
      +      "AUTHORIZATION_CREDENTIAL_INVALID",
      +      "AUTHORIZATION_CREDENTIAL_EXPIRED",
      +      "INVALID_DIRECTIVE",
      +      "INVALID_VALUE",
      +      "VALUE_OUT_OF_RANGE",
      +      "NOT_SUPPORTED_IN_CURRENT_MODE",
      +      "RATE_LIMIT_EXCEEDED",
      +      "PROVIDER_SERVICE_UNAVAILABLE",
      +      "PROVIDER_TIMEOUT",
      +      "PROVIDER_INTERNAL_ERROR",
      +      "INVALID_PROVIDER_RESPONSE",
      +      "OUTCOME_UNKNOWN",
      +      "PRECONDITION_FAILED",
      +      "AUTH_LINK_NOT_READY",
      +      "AUTH_LINK_NOT_DISCONNECTABLE",
      +      "PRECONDITION_REQUIRED",
      +      "IDEMPOTENCY_KEY_REQUIRED",
      +      "IDEMPOTENCY_KEY_REUSED",
      +      "IDEMPOTENCY_KEY_IN_FLIGHT",
      +      "IDEMPOTENCY_KEY_INVALID",
      +      "GROUP_MERGED",
      +      "MULTI_ROOM_UNSUPPORTED",
      +      "MAP_NOT_ACTIVE",
      +      "TARGET_UNSUPPORTED",
      +      "TARGET_AMBIGUOUS",
      +      "TARGET_GROUP_NOT_FOUND",
      +      "TARGET_GROUP_DISABLED",
      +      "DUPLICATE_TARGET_GROUP",
      +      "MESSAGE_UNSUPPORTED",
      +      "MESSAGE_AMBIGUOUS",
      +      "ENDPOINT_DISABLED",
      +      "ENDPOINT_ROUTE_CHANGED",
      +      "ENDPOINT_HAS_DEPENDENCIES",
      +      "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
      +      "ENDPOINT_COMMITTED_CLEANUP_PENDING",
      +      "DEEP_QUERY_FAILED",
      +      "PROVIDER_NO_STATE",
      +      "EVENT_MANAGEMENT_DISABLED",
      +      "SUBSCRIPTION_IDENTITY_IMMUTABLE",
      +      "UNSUPPORTED_MEDIA_TYPE",
      +      "EVENT_PAYLOAD_TOO_LARGE",
      +      "REQUEST_BODY_TOO_LARGE",
      +      "EVENT_IDENTITY_CONFLICT",
      +      "EVENT_INGRESS_QUOTA_EXCEEDED",
      +      "EVENT_RECEIPT_EXPIRED",
      +      "EVENT_STORAGE_UNAVAILABLE",
      +      "EVENT_DEAD_LETTER_NOT_FOUND",
      +      "EVENT_REDRIVE_CONFLICT",
      +      "EVENT_REDRIVE_EXPIRED",
      +      "RECEIPT_CONTEXT_EXPIRED",
      +      "EVENT_MAINTENANCE_INCOMPLETE",
      +      "UNKNOWN_INTERFACE",
      +      "INVALID_CONFIGURATION",
      +      "INVALID_PLUGIN_MANIFEST",
      +      "INVALID_ATTRIBUTE",
      +      "INVALID_PROVIDER_MESSAGE",
      +      "UNDECLARED_CAPABILITY",
      +      "PLUGIN_ROUTE_ID_CONFLICT",
      +      "UNRESOLVED_REFERENCE",
      +      "INVALID_RELATIONSHIP",
      +      "RELATIONSHIP_CYCLE",
      +      "MULTIPLE_PARENTS",
      +      "FLOW_VALIDATION_FAILED",
      +      "PROVIDER_SYNC_UNSUPPORTED"
      +    ],
      +    "type": "string"
      +  },
      +  "ErrorDetails": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "actual": {
      +        "type": "string"
      +      },
      +      "correlationId": {
      +        "type": "string"
      +      },
      +      "correlationToken": {
      +        "type": "string"
      +      },
      +      "currentMode": {
      +        "type": "string"
      +      },
      +      "directive": {
      +        "type": "string"
      +      },
      +      "discoveryEndpointId": {
      +        "type": "string"
      +      },
      +      "endpointId": {
      +        "type": "string"
      +      },
      +      "fieldErrors": {
      +        "items": {
      +          "$ref": "#/$defs/ErrorFieldError"
      +        },
      +        "type": "array"
      +      },
      +      "maximum": {
      +        "type": "number"
      +      },
      +      "minimum": {
      +        "type": "number"
      +      },
      +      "parameter": {
      +        "type": "string"
      +      },
      +      "pluginId": {
      +        "type": "string"
      +      },
      +      "pluginRouteId": {
      +        "type": "string"
      +      },
      +      "provider": {
      +        "type": "string"
      +      },
      +      "providerCode": {
      +        "type": "string"
      +      },
      +      "retryAfterSeconds": {
      +        "minimum": 0,
      +        "type": "integer"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "ErrorFamily": {
      +    "enum": [
      +      "NOT_FOUND",
      +      "BAD_REQUEST",
      +      "UNAUTHORIZED",
      +      "FORBIDDEN",
      +      "CONFLICT",
      +      "GONE",
      +      "PRECONDITION_FAILED",
      +      "PRECONDITION_REQUIRED",
      +      "PAYLOAD_TOO_LARGE",
      +      "UNSUPPORTED_MEDIA_TYPE",
      +      "UNPROCESSABLE_ENTITY",
      +      "LOCKED",
      +      "TOO_MANY_REQUESTS",
      +      "BAD_GATEWAY",
      +      "SERVICE_UNAVAILABLE",
      +      "GATEWAY_TIMEOUT",
      +      "NOT_IMPLEMENTED",
      +      "INTERNAL_SERVER_ERROR",
      +      "REQUEST_INVALID",
      +      "AUTHENTICATION",
      +      "PERMISSION",
      +      "ENDPOINT_NOT_FOUND",
      +      "ENDPOINT_STATE_CONFLICT",
      +      "ENDPOINT_UNAVAILABLE",
      +      "RATE_LIMIT",
      +      "PROVIDER_BAD_RESPONSE",
      +      "PROVIDER_UNAVAILABLE",
      +      "PROVIDER_TIMEOUT"
      +    ],
      +    "type": "string"
      +  },
      +  "ErrorFieldError": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "field": {
      +        "type": "string"
      +      },
      +      "reason": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "field",
      +      "reason"
      +    ],
      +    "type": "object"
      +  },
      +  "SynchronizationItemError": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "code": {
      +        "$ref": "#/$defs/ErrorCode"
      +      },
      +      "family": {
      +        "$ref": "#/$defs/ErrorFamily"
      +      },
      +      "interface": {
      +        "type": "string"
      +      },
      +      "message": {
      +        "type": "string"
      +      },
      +      "pluginRouteId": {
      +        "type": "string"
      +      },
      +      "relationshipExternalId": {
      +        "type": "string"
      +      },
      +      "status": {
      +        "maximum": 599,
      +        "minimum": 400,
      +        "type": "integer"
      +      },
      +      "version": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "code",
      +      "family",
      +      "status",
      +      "message"
      +    ],
      +    "type": "object"
      +  }
      +}
    • changedOutput schema / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "type": "string"
      -      },
      -      "status": {
      -        "const": "stopped"
      -      }
      -    },
      -    "required": [
      -      "id",
      -      "status"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "description": "The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.",
      -    "properties": {
      -      "code": {
      -        "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
      -        "enum": [
      -          "BAD_REQUEST",
      -          "UNAUTHORIZED",
      -          "FORBIDDEN",
      -          "INSUFFICIENT_SCOPE",
      -          "NOT_FOUND",
      -          "CONFLICT",
      -          "UNPROCESSABLE_ENTITY",
      -          "UNSUPPORTED_OPERATION",
      -          "TOO_MANY_REQUESTS",
      -          "SERVICE_UNAVAILABLE",
      -          "NOT_IMPLEMENTED",
      -          "INTERNAL",
      -          "CHECKSUM_MISMATCH",
      -          "FILE_TOO_LARGE",
      -          "STORAGE_UNAVAILABLE",
      -          "INSUFFICIENT_PERMISSIONS",
      -          "INVALID_FILE_TYPE",
      -          "QUOTA_EXCEEDED",
      -          "CONCURRENT_MODIFICATION",
      -          "ENDPOINT_UNREACHABLE",
      -          "BRIDGE_UNREACHABLE",
      -          "CLOUD_CONTROL_DISABLED",
      -          "ENDPOINT_BUSY",
      -          "ENDPOINT_LOW_POWER",
      -          "AUTHORIZATION_CREDENTIAL_INVALID",
      -          "AUTHORIZATION_CREDENTIAL_EXPIRED",
      -          "INVALID_DIRECTIVE",
      -          "INVALID_VALUE",
      -          "VALUE_OUT_OF_RANGE",
      -          "NOT_SUPPORTED_IN_CURRENT_MODE",
      -          "RATE_LIMIT_EXCEEDED",
      -          "PROVIDER_SERVICE_UNAVAILABLE",
      -          "PROVIDER_TIMEOUT",
      -          "PROVIDER_INTERNAL_ERROR",
      -          "INVALID_PROVIDER_RESPONSE",
      -          "OUTCOME_UNKNOWN",
      -          "PRECONDITION_FAILED",
      -          "AUTH_LINK_NOT_READY",
      -          "AUTH_LINK_NOT_DISCONNECTABLE",
      -          "PRECONDITION_REQUIRED",
      -          "IDEMPOTENCY_KEY_REQUIRED",
      -          "IDEMPOTENCY_KEY_REUSED",
      -          "IDEMPOTENCY_KEY_IN_FLIGHT",
      -          "IDEMPOTENCY_KEY_INVALID",
      -          "GROUP_MERGED",
      -          "MULTI_ROOM_UNSUPPORTED",
      -          "MAP_NOT_ACTIVE",
      -          "TARGET_UNSUPPORTED",
      -          "TARGET_AMBIGUOUS",
      -          "TARGET_GROUP_NOT_FOUND",
      -          "TARGET_GROUP_DISABLED",
      -          "DUPLICATE_TARGET_GROUP",
      -          "MESSAGE_UNSUPPORTED",
      -          "MESSAGE_AMBIGUOUS",
      -          "ENDPOINT_DISABLED",
      -          "ENDPOINT_ROUTE_CHANGED",
      -          "ENDPOINT_HAS_DEPENDENCIES",
      -          "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
      -          "ENDPOINT_COMMITTED_CLEANUP_PENDING",
      -          "DEEP_QUERY_FAILED",
      -          "PROVIDER_NO_STATE",
      -          "EVENT_MANAGEMENT_DISABLED",
      -          "SUBSCRIPTION_IDENTITY_IMMUTABLE",
      -          "UNSUPPORTED_MEDIA_TYPE",
      -          "EVENT_PAYLOAD_TOO_LARGE",
      -          "REQUEST_BODY_TOO_LARGE",
      -          "EVENT_IDENTITY_CONFLICT",
      -          "EVENT_INGRESS_QUOTA_EXCEEDED",
      -          "EVENT_RECEIPT_EXPIRED",
      -          "EVENT_STORAGE_UNAVAILABLE",
      -          "EVENT_DEAD_LETTER_NOT_FOUND",
      -          "EVENT_REDRIVE_CONFLICT",
      -          "EVENT_REDRIVE_EXPIRED",
      -          "RECEIPT_CONTEXT_EXPIRED",
      -          "EVENT_MAINTENANCE_INCOMPLETE",
      -          "UNKNOWN_INTERFACE",
      -          "INVALID_CONFIGURATION",
      -          "INVALID_PLUGIN_MANIFEST",
      -          "INVALID_ATTRIBUTE",
      -          "INVALID_PROVIDER_MESSAGE",
      -          "UNDECLARED_CAPABILITY",
      -          "PLUGIN_ROUTE_ID_CONFLICT",
      -          "UNRESOLVED_REFERENCE",
      -          "INVALID_RELATIONSHIP",
      -          "RELATIONSHIP_CYCLE",
      -          "MULTIPLE_PARENTS",
      -          "FLOW_VALIDATION_FAILED",
      -          "PROVIDER_SYNC_UNSUPPORTED"
      -        ],
      -        "type": "string"
      -      },
      -      "details": {
      -        "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
      -        "properties": {
      -          "actual": {
      -            "description": "String representation of the submitted value when the plugin can safely report it.",
      -            "type": "string"
      -          },
      -          "correlationId": {
      -            "description": "Provider or plugin correlation ID useful for support.",
      -            "type": "string"
      -          },
      -          "correlationToken": {
      -            "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
      -            "type": "string"
      -          },
      -          "currentMode": {
      -            "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
      -            "type": "string"
      -          },
      -          "directive": {
      -            "description": "Message namespace and name or provider directive that failed.",
      -            "type": "string"
      -          },
      -          "discoveryEndpointId": {
      -            "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
      -            "type": "string"
      -          },
      -          "endpointId": {
      -            "description": "Port OS endpoint ID involved in the failed dispatch.",
      -            "type": "string"
      -          },
      -          "fieldErrors": {
      -            "description": "The request fields that were rejected, when the error is about the request's content.",
      -            "items": {
      -              "description": "One rejected request field of an error.",
      -              "properties": {
      -                "field": {
      -                  "description": "Name or JSON path of the rejected field.",
      -                  "type": "string"
      -                },
      -                "reason": {
      -                  "description": "Why the field was rejected and what an accepted value looks like.",
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "field",
      -                "reason"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          "maximum": {
      -            "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
      -            "type": "number"
      -          },
      -          "minimum": {
      -            "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
      -            "type": "number"
      -          },
      -          "parameter": {
      -            "description": "Request parameter or capability value that caused the failure.",
      -            "type": "string"
      -          },
      -          "pluginId": {
      -            "description": "Port OS plugin ID that reported the failure.",
      -            "type": "string"
      -          },
      -          "pluginRouteId": {
      -            "description": "Plugin-owned route identifier involved in the failed dispatch.",
      -            "type": "string"
      -          },
      -          "provider": {
      -            "description": "Third-party provider or bridge name that reported the failure.",
      -            "type": "string"
      -          },
      -          "providerCode": {
      -            "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
      -            "type": "string"
      -          },
      -          "retryAfterSeconds": {
      -            "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
      -            "minimum": 0,
      -            "type": "integer"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "errors": {
      -        "description": "Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.\n",
      -        "items": {
      -          "description": "One rejected discovery item of a `SynchronizationRequest`, keyed by the plugin-owned identity of the rejected item: `pluginRouteId` for a route or group route, or `relationshipExternalId` for a relationship. Exactly one of the two is set. It shares the `code`, `family`, `status` and `message` fields of `BatchItemError`; discovery items are keyed by plugin-owned identity because they carry no `requestId`. A request with any rejected item is rejected as a whole and lists every rejected item.\n",
      -          "properties": {
      -            "code": {
      -              "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
      -              "enum": [
      -                "BAD_REQUEST",
      -                "UNAUTHORIZED",
      -                "FORBIDDEN",
      -                "INSUFFICIENT_SCOPE",
      -                "NOT_FOUND",
      -                "CONFLICT",
      -                "UNPROCESSABLE_ENTITY",
      -                "UNSUPPORTED_OPERATION",
      -                "TOO_MANY_REQUESTS",
      -                "SERVICE_UNAVAILABLE",
      -                "NOT_IMPLEMENTED",
      -                "INTERNAL",
      -                "CHECKSUM_MISMATCH",
      -                "FILE_TOO_LARGE",
      -                "STORAGE_UNAVAILABLE",
      -                "INSUFFICIENT_PERMISSIONS",
      -                "INVALID_FILE_TYPE",
      -                "QUOTA_EXCEEDED",
      -                "CONCURRENT_MODIFICATION",
      -                "ENDPOINT_UNREACHABLE",
      -                "BRIDGE_UNREACHABLE",
      -                "CLOUD_CONTROL_DISABLED",
      -                "ENDPOINT_BUSY",
      -                "ENDPOINT_LOW_POWER",
      -                "AUTHORIZATION_CREDENTIAL_INVALID",
      -                "AUTHORIZATION_CREDENTIAL_EXPIRED",
      -                "INVALID_DIRECTIVE",
      -                "INVALID_VALUE",
      -                "VALUE_OUT_OF_RANGE",
      -                "NOT_SUPPORTED_IN_CURRENT_MODE",
      -                "RATE_LIMIT_EXCEEDED",
      -                "PROVIDER_SERVICE_UNAVAILABLE",
      -                "PROVIDER_TIMEOUT",
      -                "PROVIDER_INTERNAL_ERROR",
      -                "INVALID_PROVIDER_RESPONSE",
      -                "OUTCOME_UNKNOWN",
      -                "PRECONDITION_FAILED",
      -                "AUTH_LINK_NOT_READY",
      -                "AUTH_LINK_NOT_DISCONNECTABLE",
      -                "PRECONDITION_REQUIRED",
      -                "IDEMPOTENCY_KEY_REQUIRED",
      -                "IDEMPOTENCY_KEY_REUSED",
      -                "IDEMPOTENCY_KEY_IN_FLIGHT",
      -                "IDEMPOTENCY_KEY_INVALID",
      -                "GROUP_MERGED",
      -                "MULTI_ROOM_UNSUPPORTED",
      -                "MAP_NOT_ACTIVE",
      -                "TARGET_UNSUPPORTED",
      -                "TARGET_AMBIGUOUS",
      -                "TARGET_GROUP_NOT_FOUND",
      -                "TARGET_GROUP_DISABLED",
      -                "DUPLICATE_TARGET_GROUP",
      -                "MESSAGE_UNSUPPORTED",
      -                "MESSAGE_AMBIGUOUS",
      -                "ENDPOINT_DISABLED",
      -                "ENDPOINT_ROUTE_CHANGED",
      -                "ENDPOINT_HAS_DEPENDENCIES",
      -                "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
      -                "ENDPOINT_COMMITTED_CLEANUP_PENDING",
      -                "DEEP_QUERY_FAILED",
      -                "PROVIDER_NO_STATE",
      -                "EVENT_MANAGEMENT_DISABLED",
      -                "SUBSCRIPTION_IDENTITY_IMMUTABLE",
      -                "UNSUPPORTED_MEDIA_TYPE",
      -                "EVENT_PAYLOAD_TOO_LARGE",
      -                "REQUEST_BODY_TOO_LARGE",
      -                "EVENT_IDENTITY_CONFLICT",
      -                "EVENT_INGRESS_QUOTA_EXCEEDED",
      -                "EVENT_RECEIPT_EXPIRED",
      -                "EVENT_STORAGE_UNAVAILABLE",
      -                "EVENT_DEAD_LETTER_NOT_FOUND",
      -                "EVENT_REDRIVE_CONFLICT",
      -                "EVENT_REDRIVE_EXPIRED",
      -                "RECEIPT_CONTEXT_EXPIRED",
      -                "EVENT_MAINTENANCE_INCOMPLETE",
      -                "UNKNOWN_INTERFACE",
      -                "INVALID_CONFIGURATION",
      -                "INVALID_PLUGIN_MANIFEST",
      -                "INVALID_ATTRIBUTE",
      -                "INVALID_PROVIDER_MESSAGE",
      -                "UNDECLARED_CAPABILITY",
      -                "PLUGIN_ROUTE_ID_CONFLICT",
      -                "UNRESOLVED_REFERENCE",
      -                "INVALID_RELATIONSHIP",
      -                "RELATIONSHIP_CYCLE",
      -                "MULTIPLE_PARENTS",
      -                "FLOW_VALIDATION_FAILED",
      -                "PROVIDER_SYNC_UNSUPPORTED"
      -              ],
      -              "type": "string"
      -            },
      -            "family": {
      -              "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
      -              "enum": [
      -                "NOT_FOUND",
      -                "BAD_REQUEST",
      -                "UNAUTHORIZED",
      -                "FORBIDDEN",
      -                "CONFLICT",
      -                "GONE",
      -                "PRECONDITION_FAILED",
      -                "PRECONDITION_REQUIRED",
      -                "PAYLOAD_TOO_LARGE",
      -                "UNSUPPORTED_MEDIA_TYPE",
      -                "UNPROCESSABLE_ENTITY",
      -                "LOCKED",
      -                "TOO_MANY_REQUESTS",
      -                "BAD_GATEWAY",
      -                "SERVICE_UNAVAILABLE",
      -                "GATEWAY_TIMEOUT",
      -                "NOT_IMPLEMENTED",
      -                "INTERNAL_SERVER_ERROR",
      -                "REQUEST_INVALID",
      -                "AUTHENTICATION",
      -                "PERMISSION",
      -                "ENDPOINT_NOT_FOUND",
      -                "ENDPOINT_STATE_CONFLICT",
      -                "ENDPOINT_UNAVAILABLE",
      -                "RATE_LIMIT",
      -                "PROVIDER_BAD_RESPONSE",
      -                "PROVIDER_UNAVAILABLE",
      -                "PROVIDER_TIMEOUT"
      -              ],
      -              "type": "string"
      -            },
      -            "interface": {
      -              "description": "Canonical capability interface name the failure applies to, when the failure is interface-specific.",
      -              "type": "string"
      -            },
      -            "message": {
      -              "description": "Plain-language description of the failure and the suggested fix.",
      -              "type": "string"
      -            },
      -            "pluginRouteId": {
      -              "description": "Plugin-owned identifier of the rejected route or group route. Set unless the item is a relationship.",
      -              "type": "string"
      -            },
      -            "relationshipExternalId": {
      -              "description": "Plugin-owned `externalId` of the rejected relationship. Set only for relationship items.",
      -              "type": "string"
      -            },
      -            "status": {
      -              "description": "HTTP-equivalent status code of the item failure.",
      -              "maximum": 599,
      -              "minimum": 400,
      -              "type": "integer"
      -            },
      -            "version": {
      -              "description": "Declared capability interface version the failure applies to, when the failure is interface-specific.",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "code",
      -            "family",
      -            "status",
      -            "message"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "family": {
      -        "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
      -        "enum": [
      -          "NOT_FOUND",
      -          "BAD_REQUEST",
      -          "UNAUTHORIZED",
      -          "FORBIDDEN",
      -          "CONFLICT",
      -          "GONE",
      -          "PRECONDITION_FAILED",
      -          "PRECONDITION_REQUIRED",
      -          "PAYLOAD_TOO_LARGE",
      -          "UNSUPPORTED_MEDIA_TYPE",
      -          "UNPROCESSABLE_ENTITY",
      -          "LOCKED",
      -          "TOO_MANY_REQUESTS",
      -          "BAD_GATEWAY",
      -          "SERVICE_UNAVAILABLE",
      -          "GATEWAY_TIMEOUT",
      -          "NOT_IMPLEMENTED",
      -          "INTERNAL_SERVER_ERROR",
      -          "REQUEST_INVALID",
      -          "AUTHENTICATION",
      -          "PERMISSION",
      -          "ENDPOINT_NOT_FOUND",
      -          "ENDPOINT_STATE_CONFLICT",
      -          "ENDPOINT_UNAVAILABLE",
      -          "RATE_LIMIT",
      -          "PROVIDER_BAD_RESPONSE",
      -          "PROVIDER_UNAVAILABLE",
      -          "PROVIDER_TIMEOUT"
      -        ],
      -        "type": "string"
      -      },
      -      "message": {
      -        "description": "Plain-language description of the failure and the suggested next action.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "family",
      -      "code",
      -      "message"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "id": {
      +        "type": "string"
      +      },
      +      "status": {
      +        "const": "stopped"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "status"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "code": {
      +        "$ref": "#/$defs/ErrorCode"
      +      },
      +      "details": {
      +        "$ref": "#/$defs/ErrorDetails"
      +      },
      +      "errors": {
      +        "items": {
      +          "$ref": "#/$defs/SynchronizationItemError"
      +        },
      +        "type": "array"
      +      },
      +      "family": {
      +        "$ref": "#/$defs/ErrorFamily"
      +      },
      +      "message": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "family",
      +      "code",
      +      "message"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed3 schema fields changed
    • addedInput schema / properties / idempotencyKey
      Added value: +{
      +  "description": "Stable unique key for this write; reuse it only to retry the same request for 24 hours.",
      +  "maxLength": 255,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / ifMatch
      Added value: +{
      +  "description": "Exact strong etag from subscription_inspect or subscription_list.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "id"
      -]New value: +[
      +  "idempotencyKey",
      +  "ifMatch",
      +  "id"
      +]
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already declare this is destructive, non-read-only, and idempotent. The description adds useful behavioral context beyond annotations by confirming idempotency and explaining that a stopped monitor requires a new subscription to resume watching.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core action and contains no wasted sentences. The idempotency note and post-cancellation consequence each add distinct value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has complete schema descriptions, rich annotations, and an output schema. The description completes the picture by explaining the source of the ID, idempotency behavior, and the consequence of cancellation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameters are already well documented. The description reinforces that the ID must come from subscription_list or subscription_inspect and that names are not keys, but it does not add details for ifMatch or idempotencyKey beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: cancelling one Port OS event subscription. It also distinguishes this from subscription_list and subscription_inspect by requiring the exact subscription ID from those tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly establishes the usage context: stop watching an event subscription, using an ID obtained from subscription_list or subscription_inspect. It also warns that names are not cancellation keys, though it does not explicitly compare against subscription_label_edit or state when not to cancel.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources