Skip to main content
Glama
ibm-ecm

Core Content Services MCP Server

Official
by ibm-ecm

checkin_document

Check in a document to the content repository by specifying identifier, check-in action, and document properties to update. Optionally upload new file content.

Instructions

Checks in a document in the content repository with specified properties.

:param identifier: The identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID). :param checkin_action: Check-in action parameters for the document. :param document_properties: Properties to update for the document during check-in. :param file_paths: Optional list of file paths to upload as the document's content.

:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
identifierYes
checkin_actionNo
document_propertiesNo
file_pathsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv1.0.4
    • removedInput schema / $defs
      Removed value: -{
      -  "DocumentPropertiesInput": {
      -    "description": "Input for document properties.",
      -    "properties": {
      -      "cmRetentionDate": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Retention date",
      -        "title": "Cmretentiondate"
      -      },
      -      "compoundDocumentState": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Compound document state",
      -        "title": "Compounddocumentstate"
      -      },
      -      "content": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Content can be specified if this represents a Reservation document or document creation",
      -        "title": "Content"
      -      },
      -      "mimeType": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Mime type",
      -        "title": "Mimetype"
      -      },
      -      "name": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Name sets DocumentTitle or whatever property is configured as the Name property",
      -        "title": "Name"
      -      },
      -      "owner": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Owner",
      -        "title": "Owner"
      -      },
      -      "properties": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "$ref": "#/$defs/PropertyIdentifierAndScalarValue"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Properties for Document",
      -        "title": "Properties"
      -      }
      -    },
      -    "title": "DocumentPropertiesInput",
      -    "type": "object"
      -  },
      -  "PropertyIdentifierAndScalarValue": {
      -    "description": "Represents a property with an identifier and scalar value.",
      -    "properties": {
      -      "identifier": {
      -        "description": "Property identifier",
      -        "title": "Identifier",
      -        "type": "string"
      -      },
      -      "value": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "boolean"
      -          },
      -          {},
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Property value",
      -        "title": "Value"
      -      }
      -    },
      -    "required": [
      -      "identifier"
      -    ],
      -    "title": "PropertyIdentifierAndScalarValue",
      -    "type": "object"
      -  },
      -  "SubCheckinActionInput": {
      -    "description": "Input for document check-in action.",
      -    "properties": {
      -      "autoClassify": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Whether to automatically classify the document. User must explicitly set this value, else it will be None by default",
      -        "title": "Autoclassify"
      -      },
      -      "checkinMinorVersion": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": false,
      -        "description": "Whether to check in as a minor version. By default, this is False since we always check in as major version unless specified by the user.",
      -        "title": "Checkinminorversion"
      -      }
      -    },
      -    "title": "SubCheckinActionInput",
      -    "type": "object"
      -  }
      -}
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / checkin_action / anyOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/SubCheckinActionInput"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Input for document check-in action.",
      +    "properties": {
      +      "autoClassify": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Whether to automatically classify the document. User must explicitly set this value, else it will be None by default"
      +      },
      +      "checkinMinorVersion": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": false,
      +        "description": "Whether to check in as a minor version. By default, this is False since we always check in as major version unless specified by the user."
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / document_properties / anyOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/DocumentPropertiesInput"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Input for document properties.",
      +    "properties": {
      +      "cmRetentionDate": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Retention date"
      +      },
      +      "compoundDocumentState": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Compound document state"
      +      },
      +      "content": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Content can be specified if this represents a Reservation document or document creation"
      +      },
      +      "mimeType": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Mime type"
      +      },
      +      "name": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Name sets DocumentTitle or whatever property is configured as the Name property"
      +      },
      +      "owner": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Owner"
      +      },
      +      "properties": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "description": "Represents a property with an identifier and scalar value.",
      +              "properties": {
      +                "identifier": {
      +                  "description": "Property identifier",
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "anyOf": [
      +                    {
      +                      "type": "string"
      +                    },
      +                    {
      +                      "type": "integer"
      +                    },
      +                    {
      +                      "type": "number"
      +                    },
      +                    {
      +                      "type": "boolean"
      +                    },
      +                    {},
      +                    {
      +                      "type": "null"
      +                    }
      +                  ],
      +                  "default": null,
      +                  "description": "Property value"
      +                }
      +              },
      +              "required": [
      +                "identifier"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Properties for Document"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / file_paths / title
      Removed value: -"File Paths"
    • removedInput schema / properties / identifier / title
      Removed value: -"Identifier"
    • removedInput schema / title
      Removed value: -"checkin_documentArguments"
    • removedOutput schema / $defs
      Removed value: -{
      -  "Document": {
      -    "description": "Document class for the MCP server.",
      -    "properties": {
      -      "className": {
      -        "default": "Document",
      -        "description": "Class identifier for the document",
      -        "title": "Classname",
      -        "type": "string"
      -      },
      -      "contentSize": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Size of the document content",
      -        "title": "Contentsize"
      -      },
      -      "creator": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The creator of the document",
      -        "title": "Creator"
      -      },
      -      "dateCreated": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Date when document was created",
      -        "title": "Datecreated"
      -      },
      -      "dateLastModified": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Date when document was last modified",
      -        "title": "Datelastmodified"
      -      },
      -      "id": {
      -        "description": "The id of the document",
      -        "title": "Id",
      -        "type": "string"
      -      },
      -      "isVersioningEnabled": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Whether versioning is enabled",
      -        "title": "Isversioningenabled"
      -      },
      -      "lastModifier": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The last modifier of the document",
      -        "title": "Lastmodifier"
      -      },
      -      "majorVersionNumber": {
      -        "anyOf": [
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Major version number",
      -        "title": "Majorversionnumber"
      -      },
      -      "mimeType": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "MIME type of the document",
      -        "title": "Mimetype"
      -      },
      -      "minorVersionNumber": {
      -        "anyOf": [
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Minor version number",
      -        "title": "Minorversionnumber"
      -      },
      -      "name": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The name of the document",
      -        "title": "Name"
      -      },
      -      "owner": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The owner of the document",
      -        "title": "Owner"
      -      },
      -      "properties": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": true,
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Document properties",
      -        "title": "Properties"
      -      }
      -    },
      -    "required": [
      -      "id"
      -    ],
      -    "title": "Document",
      -    "type": "object"
      -  },
      -  "ToolError": {
      -    "description": "Represents an error response from a tool execution.\n\nThis class helps the LLM understand error messages and provides suggestions\nfor potential resolutions.",
      -    "properties": {
      -      "isError": {
      -        "const": true,
      -        "default": true,
      -        "description": "Indicates that an error occurred during tool execution if value is True",
      -        "title": "Iserror",
      -        "type": "boolean"
      -      },
      -      "message": {
      -        "description": "Detailed error message",
      -        "title": "Message",
      -        "type": "string"
      -      },
      -      "suggestions": {
      -        "description": "List of suggestions for resolving the error",
      -        "items": {
      -          "type": "string"
      -        },
      -        "title": "Suggestions",
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "message"
      -    ],
      -    "title": "ToolError",
      -    "type": "object"
      -  }
      -}
    • changedOutput schema / properties / result / anyOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/Document"
      -  },
      -  {
      -    "$ref": "#/$defs/ToolError"
      -  }
      -]New value: +[
      +  {
      +    "description": "Document class for the MCP server.",
      +    "properties": {
      +      "className": {
      +        "default": "Document",
      +        "description": "Class identifier for the document",
      +        "type": "string"
      +      },
      +      "contentSize": {
      +        "anyOf": [
      +          {
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Size of the document content"
      +      },
      +      "creator": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The creator of the document"
      +      },
      +      "dateCreated": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Date when document was created"
      +      },
      +      "dateLastModified": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Date when document was last modified"
      +      },
      +      "id": {
      +        "description": "The id of the document",
      +        "type": "string"
      +      },
      +      "isVersioningEnabled": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Whether versioning is enabled"
      +      },
      +      "lastModifier": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The last modifier of the document"
      +      },
      +      "majorVersionNumber": {
      +        "anyOf": [
      +          {
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Major version number"
      +      },
      +      "mimeType": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "MIME type of the document"
      +      },
      +      "minorVersionNumber": {
      +        "anyOf": [
      +          {
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Minor version number"
      +      },
      +      "name": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The name of the document"
      +      },
      +      "owner": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The owner of the document"
      +      },
      +      "properties": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": true,
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Document properties"
      +      }
      +    },
      +    "required": [
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "description": "Represents an error response from a tool execution.\n\nThis class helps the LLM understand error messages and provides suggestions\nfor potential resolutions.",
      +    "properties": {
      +      "isError": {
      +        "const": true,
      +        "default": true,
      +        "description": "Indicates that an error occurred during tool execution if value is True",
      +        "type": "boolean"
      +      },
      +      "message": {
      +        "description": "Detailed error message",
      +        "type": "string"
      +      },
      +      "suggestions": {
      +        "description": "List of suggestions for resolving the error",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "message"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"checkin_documentOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  2. First observedv1.0.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are provided, so the description must convey behavioral traits. It discloses return type (Document or ToolError) and the fact that properties are updated, but does not mention required permissions, side effects, or prerequisites like checkout state.

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

Conciseness3/5

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

The description is structured as a docstring with parameter explanations, which is clear but somewhat verbose. It is appropriately sized for four parameters but redundant in places (e.g., 'Check-in action parameters for the document').

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

Completeness3/5

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

The tool has four parameters and returns an object. The description covers basic functionality but omits important context like prerequisites (e.g., document must be checked out) and detailed error conditions. Given the complexity, it is adequate but not complete.

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 0% at the top level, but nested objects have descriptions. The description adds meaning for identifier (prioritization logic) and file_paths (file uploads), but other parameters are merely restated without additional guidance beyond what the schema provides.

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

Purpose4/5

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

The description clearly states the verb 'Checks in' and the resource 'document in the content repository', which differentiates from sibling tools like checkout_document. However, it does not explicitly contrast with siblings, missing a 5.

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

Usage Guidelines3/5

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

The description explains the identifier parameter prioritization but lacks explicit guidance on when to use this tool versus alternatives (e.g., checkout_document). Usage context is implied but not stated.

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