Skip to main content
Glama
ibm-ecm

Core Content Services MCP Server

Official
by ibm-ecm

get_document_annotations_tool

Retrieve annotation metadata for documents including creator, dates, descriptions, and content elements to analyze annotations or identify them for processing.

Instructions

Retrieves all annotations associated with a document.

This tool fetches annotation metadata including creator, dates, descriptive text, and content element information. Use this to analyze document annotations or to identify specific annotations for further processing.

:param document_id: The document ID to retrieve annotations for.

:returns: A dictionary containing document annotations with the following structure: - data.document.annotations.annotations: List of annotation objects, each containing: - className: The class name of the annotation - creator: The creator of the annotation - dateCreated: Creation timestamp - dateLastModified: Last modification timestamp - id: Unique identifier of the annotation - name: Name of the annotation - owner: Owner of the annotation - descriptiveText: Text description of the annotation - contentSize: Size of the annotation content - mimeType: MIME type of the annotation - annotatedContentElement: Content element being annotated - contentElementsPresent: Whether content elements are present - contentElements: List of content elements with className, contentType, and sequence

    Returns ToolError if the document doesn't exist or another error occurs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It describes what the tool does (retrieves annotation metadata) and mentions error handling (returns ToolError for non-existent documents or errors), but it lacks details on permissions, rate limits, or side effects, which are important for a read operation in a document management context.

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 appropriately sized and front-loaded, starting with the core purpose and usage, followed by parameter and return details. However, the return structure is detailed extensively, which might be verbose given that an output schema exists, though it helps compensate for the lack of annotations.

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

Completeness4/5

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

Given the complexity of document annotations, the description is fairly complete: it explains the purpose, parameter, and detailed return structure. Since an output schema exists, the detailed return explanation is somewhat redundant but adds value due to no annotations. It could improve by addressing permissions or error specifics.

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

Parameters5/5

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

The schema description coverage is 0%, so the description must compensate. It explicitly defines the single parameter 'document_id' with a clear explanation ('The document ID to retrieve annotations for'), adding essential meaning beyond the basic schema, which only provides a title and type without context.

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 clearly states the tool's purpose with a specific verb ('retrieves') and resource ('annotations associated with a document'), distinguishing it from siblings like get_document_properties or get_document_text_extract by focusing exclusively on annotations rather than general properties or text content.

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?

The description provides clear context for when to use this tool ('to analyze document annotations or to identify specific annotations for further processing'), but it does not explicitly state when not to use it or name alternatives among the sibling tools, such as for general document properties or text extraction.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ibm-ecm/cs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server