Skip to main content
Glama
Core Content Services MCP Server

Core Content Services MCP Server

Official
by ibm-ecm

checkin_document

Checks in a document to the content repository by reservation or document ID, applying optional file content, metadata, versioning, and classification settings.

Instructions

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

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": {
      "identifier": "<identifier>"
    },
    "name": "checkin_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_pathsNoOptional list of file paths to upload as the document's content.
identifierYesThe identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID).
checkin_actionNoCheck-in action parameters for the document.
document_propertiesNoProperties to update for the document during check-in.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.0.5
    • addedInput schema / properties / checkin_action / description
      Added value: +"Check-in action parameters for the document."
    • addedInput schema / properties / document_properties / description
      Added value: +"Properties to update for the document during check-in."
    • addedInput schema / properties / file_paths / description
      Added value: +"Optional list of file paths to upload as the document's content."
    • addedInput schema / properties / identifier / description
      Added value: +"The identifier (required). This can be either a reservation_id or document_id.\nReservation ID (GUID) is prioritized.\nOtherwise, we use document_id (GUID)."
  2. 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
  3. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description alone must disclose behavioral traits. It only states the basic action, failing to mention side effects (e.g., overwriting content, creating a new version), required permissions, or whether the operation is reversible. The description does not add any behavioral context beyond the name.

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

Conciseness4/5

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

The description is a single, clear sentence with no wasted words. It is front-loaded with the action verb. However, it could be slightly expanded to include key context without losing conciseness.

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

Completeness2/5

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

Given the complexity (4 parameters, including nested objects) and the presence of an output schema, the description is incomplete. It does not explain the check-in workflow (e.g., prerequisite checkout), what happens to file_paths, or how properties are applied. The description does not compensate for the lack of annotations.

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 baseline is 3. The description adds no meaning beyond the schema—'with specified properties' is already implied by the parameters. No parameter details in the description itself, which meets the minimum but adds no value.

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 uses a specific verb ('checks in') and resource ('document'), clearly indicating the action. It implicitly distinguishes from the sibling 'checkout_document' by being the inverse, but does not explicitly differentiate from other document tools like 'create_document' or 'update_document_properties'.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. It does not mention that a document must be checked out first, nor does it state when not to use it. Sibling tools like 'checkout_document' or 'create_document' are not referenced in the description.

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