get_document_versions
Retrieve all document versions in a version series to track changes and access historical or future revisions in IBM Content Manager.
Instructions
Retrieves all versions in the version series that includes the specified document. This returns all versions (past, current, and future) that belong to the same version series.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: A dictionary containing the version series details, including: - versionSeries (dict): A dictionary containing version series details, including: - versions (list): A list of all versions in the series, with each version containing: - majorVersionNumber (int): The major version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - minorVersionNumber (int): The minor version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - id (str): The unique identifier of the version's document id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Implementation Reference
- The asynchronous handler function that executes the GraphQL query to retrieve all versions in the document's version series.async def get_document_versions(identifier: str) -> dict: """ Retrieves all versions in the version series that includes the specified document. This returns all versions (past, current, and future) that belong to the same version series. :param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :returns: A dictionary containing the version series details, including: - versionSeries (dict): A dictionary containing version series details, including: - versions (list): A list of all versions in the series, with each version containing: - majorVersionNumber (int): The major version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - minorVersionNumber (int): The minor version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - id (str): The unique identifier of the version's document id. """ query = """ query getDocumentVersions($object_store_name: String!, $identifier: String!){ document( repositoryIdentifier: $object_store_name identifier: $identifier ) { versionSeries { versions { versionables { id majorVersionNumber minorVersionNumber } } } } } """ variables = { "identifier": identifier, "object_store_name": graphql_client.object_store, } return await graphql_client.execute_async(query=query, variables=variables)
- src/cs_mcp_server/tools/documents.py:49-51 (registration)The @mcp.tool decorator that registers the get_document_versions tool within the register_document_tools function.@mcp.tool( name="get_document_versions", )