API Reference

Complete reference for all Alfresco MCP Server tools, resources, and prompts. This document provides detailed information about parameters, responses, and usage examples for our modular FastMCP 2.0 architecture.

📋 Overview

The Alfresco MCP Server provides 15 tools for document management, 1 repository resource, and 1 AI-powered prompt for analysis.

Quick Reference

🔍 Search Tools (4)

Tool	Purpose	Input	Output
`search_content`	Search documents/folders	query, max_results, node_type	Search results with nodes
`advanced_search`	Advanced search with filters	query, content_type, created_after, etc.	Filtered search results
`search_by_metadata`	Search by metadata properties	property_name, property_value, comparison	Property-based results
`cmis_search`	CMIS SQL queries	cmis_query, preset, max_results	SQL query results

🛠️ Core Tools (11)

Tool	Purpose	Input	Output
`browse_repository`	Browse repository folders	node_id	Folder contents
`repository_info`	Get repository information	None	Repository status/info
`upload_document`	Upload new document	filename, content_base64, parent_id	Upload status
`download_document`	Download document content	node_id, save_to_disk	Base64 encoded content
`create_folder`	Create new folder	folder_name, parent_id, description	Creation status
`get_node_properties`	Get node metadata	node_id	Properties object
`update_node_properties`	Update metadata	node_id, name, title, description, author	Update status
`delete_node`	Delete document/folder	node_id, permanent	Deletion status
`checkout_document`	Lock document for editing	node_id, download_for_editing	Checkout status
`checkin_document`	Save new version	node_id, comment, major_version, file_path	Checkin status
`cancel_checkout`	Cancel checkout/unlock	node_id	Cancel status

📄 Resources (1)

Resource	Purpose	URI	Output
`repository_info`	Repository status and configuration	alfresco://repository/info	Repository details

🔍 Search Tools

`search_content`

Search for documents and folders in the Alfresco repository.

Parameters:

{
  "query": "string",          // Search query (required)
  "max_results": "integer"    // Maximum results to return (optional, default: 25)
}

Response:

{
  "results": [
    {
      "id": "node-id",
      "name": "document.pdf",
      "nodeType": "cm:content",
      "isFile": true,
      "isFolder": false,
      "properties": {
        "cm:title": "Document Title",
        "cm:description": "Document description",
        "cm:created": "2024-01-15T10:30:00.000Z",
        "cm:modified": "2024-01-15T15:45:00.000Z",
        "cm:creator": "admin",
        "cm:modifier": "user1"
      },
      "path": "/Company Home/Sites/example/documentLibrary/document.pdf"
    }
  ],
  "totalCount": 1
}

Example:

# Basic search
result = await client.call_tool("search_content", {
    "query": "financial report",
    "max_results": 10
})

# Wildcard search
result = await client.call_tool("search_content", {
    "query": "*",
    "max_results": 5
})

# Specific term search
result = await client.call_tool("search_content", {
    "query": "budget 2024"
})

`advanced_search`

Advanced search with filters, sorting, and AFTS query language support.

Parameters:

{
  "query": "string",            // AFTS query (required)
  "content_type": "string",     // Content type filter (optional)
  "created_after": "string",    // Date filter YYYY-MM-DD (optional)
  "created_before": "string",   // Date filter YYYY-MM-DD (optional)
  "sort_field": "string",       // Sort field (optional, default: "score")
  "sort_order": "string",       // Sort order "ASC" or "DESC" (optional)
  "max_results": "integer"      // Maximum results (optional, default: 25)
}

Example:

# Advanced search with filters
result = await client.call_tool("advanced_search", {
    "query": "TYPE:cm:content AND cm:title:financial",
    "content_type": "pdf",
    "created_after": "2024-01-01",
    "sort_field": "cm:modified",
    "sort_order": "DESC",
    "max_results": 20
})

`search_by_metadata`

Search by specific metadata properties with comparison operators.

Parameters:

{
  "property_name": "string",    // Property name (required) e.g., "cm:title"
  "property_value": "string",   // Property value to search for (required)
  "comparison": "string",       // Comparison operator (optional, default: "equals")
  "max_results": "integer"      // Maximum results (optional, default: 25)
}

Comparison operators: equals, contains, starts_with, ends_with, greater_than, less_than

Example:

# Search by title containing text
result = await client.call_tool("search_by_metadata", {
    "property_name": "cm:title",
    "property_value": "Annual Report",
    "comparison": "contains",
    "max_results": 15
})

# Search by creation date
result = await client.call_tool("search_by_metadata", {
    "property_name": "cm:created",
    "property_value": "2024-01-01",
    "comparison": "greater_than"
})

`cmis_search`

Execute CMIS SQL queries for complex content discovery.

Parameters:

{
  "cmis_query": "string",       // CMIS SQL query (required)
  "preset": "string",           // Preset query type (optional)
  "max_results": "integer"      // Maximum results (optional, default: 25)
}

Preset options: all_documents, all_folders, recent_content

Example:

# CMIS SQL query
result = await client.call_tool("cmis_search", {
    "cmis_query": "SELECT * FROM cmis:document WHERE cmis:name LIKE '%report%'",
    "max_results": 30
})

# Using preset
result = await client.call_tool("cmis_search", {
    "preset": "recent_content",
    "max_results": 10
})

🗂️ Repository Operations

`browse_repository`

Browse repository folders and their contents.

Parameters:

{
  "node_id": "string"           // Folder node ID (optional, default: "-root-")
}

Example:

# Browse root folder
result = await client.call_tool("browse_repository", {
    "node_id": "-root-"
})

# Browse specific folder
result = await client.call_tool("browse_repository", {
    "node_id": "folder-abc123-def456"
})

`repository_info`

Get repository information, version, and configuration details.

Parameters: None

Example:

# Get repository information
result = await client.call_tool("repository_info", {})

📤 Document Upload

`upload_document`

Upload a new document to the Alfresco repository.

Parameters:

{
  "filename": "string",         // Document filename (required)
  "content_base64": "string",   // Base64 encoded content (required)
  "parent_id": "string",        // Parent folder ID (optional, default: "-root-")
  "description": "string"       // Document description (optional)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "filename": "document.pdf",
  "parentId": "-root-",
  "path": "/Company Home/document.pdf"
}

Example:

import base64

# Prepare content
content = "This is my document content"
content_b64 = base64.b64encode(content.encode()).decode()

# Upload to root
result = await client.call_tool("upload_document", {
    "filename": "my_document.txt",
    "content_base64": content_b64,
    "parent_id": "-root-",
    "description": "My first document"
})

# Upload to specific folder
result = await client.call_tool("upload_document", {
    "filename": "report.pdf",
    "content_base64": pdf_content_b64,
    "parent_id": "folder-node-id",
    "description": "Monthly report"
})

📥 Document Download

`download_document`

Download the content of a document from the repository.

Parameters:

{
  "node_id": "string"   // Document node ID (required)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "filename": "document.pdf",
  "mimeType": "application/pdf",
  "size": 1024,
  "content_base64": "JVBERi0xLjQKJ..."
}

Example:

# Download document
result = await client.call_tool("download_document", {
    "node_id": "abc123-def456-ghi789"
})

# Decode content
import base64
content = base64.b64decode(result.content_base64).decode()
print(content)

🔄 Version Control

`checkout_document`

Check out a document for editing (locks the document).

Parameters:

{
  "node_id": "string"   // Document node ID (required)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "workingCopyId": "abc123-def456-ghi789-wc",
  "status": "checked_out"
}

`checkin_document`

Check in a document with a new version.

Parameters:

{
  "node_id": "string",          // Document node ID (required)
  "comment": "string",          // Version comment (optional)
  "major_version": "boolean"    // Major version increment (optional, default: false)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "version": "1.1",
  "comment": "Updated content",
  "isMajorVersion": false
}

Example:

# Checkout document
checkout_result = await client.call_tool("checkout_document", {
    "node_id": "doc-node-id"
})

# Make changes (simulated)
# ... edit the document ...

# Checkin as minor version
checkin_result = await client.call_tool("checkin_document", {
    "node_id": "doc-node-id",
    "comment": "Fixed typos and updated content",
    "major_version": False
})

# Checkin as major version
major_checkin = await client.call_tool("checkin_document", {
    "node_id": "doc-node-id", 
    "comment": "Major content overhaul",
    "major_version": True
})

`cancel_checkout`

Cancel the checkout of a document, unlocking it without saving changes.

Parameters:

{
  "node_id": "string"           // Document node ID (required)
}

Response:

{
  "success": true,
  "nodeId": "doc-node-id",
  "message": "Checkout cancelled successfully",
  "unlocked": true
}

Example:

# Cancel checkout (unlock without saving)
cancel_result = await client.call_tool("cancel_checkout", {
    "node_id": "doc-node-id"
})

# Typical workflow: checkout -> cancel if needed
checkout_result = await client.call_tool("checkout_document", {
    "node_id": "doc-node-id"
})

# If you decide not to make changes
cancel_result = await client.call_tool("cancel_checkout", {
    "node_id": "doc-node-id"
})

🗑️ Node Deletion

`delete_node`

Delete a document or folder from the repository.

Parameters:

{
  "node_id": "string",      // Node ID to delete (required)
  "permanent": "boolean"    // Permanent deletion (optional, default: false)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "permanent": false,
  "status": "moved_to_trash"
}

Example:

# Move to trash (soft delete)
result = await client.call_tool("delete_node", {
    "node_id": "node-to-delete",
    "permanent": False
})

# Permanent deletion
result = await client.call_tool("delete_node", {
    "node_id": "node-to-delete",
    "permanent": True
})

⚙️ Property Management

`get_node_properties`

Retrieve all properties and metadata for a node.

Parameters:

{
  "node_id": "string"   // Node ID (required)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "properties": {
    "cm:name": "document.pdf",
    "cm:title": "Important Document",
    "cm:description": "This is an important document",
    "cm:created": "2024-01-15T10:30:00.000Z",
    "cm:modified": "2024-01-15T15:45:00.000Z",
    "cm:creator": "admin",
    "cm:modifier": "user1",
    "cm:owner": "admin",
    "sys:node-uuid": "abc123-def456-ghi789",
    "sys:store-protocol": "workspace",
    "sys:store-identifier": "SpacesStore"
  }
}

`update_node_properties`

Update properties and metadata for a node.

Parameters:

{
  "node_id": "string",      // Node ID (required)
  "properties": "object"    // Properties to update (required)
}

Response:

{
  "success": true,
  "nodeId": "abc123-def456-ghi789",
  "updatedProperties": {
    "cm:title": "Updated Title",
    "cm:description": "Updated description"
  }
}

Example:

# Get current properties
props_result = await client.call_tool("get_node_properties", {
    "node_id": "abc123-def456-ghi789"
})

print("Current properties:", props_result[0].text)

# Update properties
update_result = await client.call_tool("update_node_properties", {
    "node_id": "abc123-def456-ghi789",
    "properties": {
        "cm:title": "Updated Document Title",
        "cm:description": "This document has been updated",
        "custom:project": "Project Alpha",
        "custom:status": "approved"
    }
})

📁 Folder Operations

`create_folder`

Create a new folder in the repository.

Parameters:

{
  "folder_name": "string",    // Folder name (required)
  "parent_id": "string",      // Parent folder ID (optional, default: "-root-")
  "description": "string"     // Folder description (optional)
}

Response:

{
  "success": true,
  "nodeId": "folder-abc123-def456",
  "folderName": "New Folder",
  "parentId": "-root-",
  "path": "/Company Home/New Folder"
}

Example:

# Create folder in root
result = await client.call_tool("create_folder", {
    "folder_name": "Project Documents",
    "parent_id": "-root-",
    "description": "Documents for the current project"
})

# Create nested folder
result = await client.call_tool("create_folder", {
    "folder_name": "Reports",
    "parent_id": "parent-folder-id",
    "description": "Monthly and quarterly reports"
})

📚 Resources

Repository Resources

Access repository information and status:

# Repository information
info = await client.read_resource("alfresco://repository/info")

# Repository health status
health = await client.read_resource("alfresco://repository/health")

# Repository statistics
stats = await client.read_resource("alfresco://repository/stats")

# Repository configuration
config = await client.read_resource("alfresco://repository/config")

Resource Responses:

{
  "repository": {
    "edition": "Community",
    "version": "7.4.0",
    "status": "healthy",
    "modules": ["content-services", "search-services"]
  }
}

💭 Prompts

`search_and_analyze`

Generate AI-powered analysis prompts for search results.

Parameters:

{
  "query": "string",            // Search query (required)
  "analysis_type": "string"     // Analysis type: summary, detailed, trends, compliance (required)
}

Response:

{
  "messages": [
    {
      "role": "user", 
      "content": {
        "type": "text",
        "text": "Based on the Alfresco search results for 'financial reports', provide a detailed analysis..."
      }
    }
  ]
}

Example:

# Generate analysis prompt
prompt_result = await client.get_prompt("search_and_analyze", {
    "query": "quarterly reports 2024",
    "analysis_type": "summary"
})

print("Generated prompt:")
print(prompt_result.messages[0].content.text)

🔍 Error Handling

All tools return consistent error responses:

{
  "success": false,
  "error": {
    "code": "ALFRESCO_ERROR",
    "message": "Authentication failed",
    "details": "Invalid username or password"
  }
}

Common error codes:

AUTHENTICATION_ERROR: Invalid credentials
NODE_NOT_FOUND: Specified node doesn't exist
PERMISSION_DENIED: Insufficient permissions
INVALID_PARAMETER: Missing or invalid parameters
CONNECTION_ERROR: Cannot connect to Alfresco server

📄 Resources

Resources provide access to repository information and metadata without modifying content.

`repository_info` (Resource) {#repository_info_resource}

Get comprehensive repository information including version, license, and configuration.

URI: alfresco://repository/info

Response:

{
  "repository": {
    "id": "alfresco-community-2023.2",
    "edition": "Community",
    "version": {
      "major": "23",
      "minor": "2", 
      "patch": "0",
      "hotfix": "0",
      "schema": "14005",
      "label": "r135432-b14",
      "display": "Community v23.2.0 (r135432-b14) schema 14005"
    },
    "status": {
      "readOnly": false,
      "auditEnabled": true,
      "quickShareEnabled": true,
      "thumbnailGenerationEnabled": true
    },
    "license": {
      "issuedAt": "2024-01-01T00:00:00.000Z",
      "expiresAt": "2024-12-31T23:59:59.000Z",
      "remainingDays": 365,
      "holder": "Community Edition",
      "mode": "ENTERPRISE",
      "entitlements": {
        "maxUsers": 0,
        "maxDocs": 0
      }
    },
    "modules": [
      {
        "id": "alfresco-share-services",
        "title": "Alfresco Share Services",
        "version": "23.2.0",
        "installState": "INSTALLED",
        "installDate": "2024-01-15T10:30:00.000Z"
      }
    ]
  }
}

Example:

# Read repository information
info = await client.read_resource("alfresco://repository/info")
print(info[0].text)

# Repository info is also available as a tool
tool_result = await client.call_tool("repository_info", {})

Use Cases:

Health checks and monitoring
Version compatibility verification
License compliance checking
System status reporting
Administrative dashboards

📊 Rate Limits and Performance

Default timeout: 30 seconds per operation
Concurrent operations: Up to 10 simultaneous requests
File size limits: 100MB per upload
Search limits: Maximum 1000 results per search

🔐 Security Considerations

All communications use HTTPS when available
Credentials are passed securely via environment variables
Base64 encoding for document content transfer
Node IDs are validated before operations

📝 Note: This API reference covers version 1.1.0 of the Alfresco MCP Server. This release includes all 15 tools with FastMCP 2.0 implementation.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Reference

📋 Overview

Quick Reference

🔍 Search Tools

`search_content`

`advanced_search`

`search_by_metadata`

`cmis_search`

🗂️ Repository Operations

`browse_repository`

`repository_info`

📤 Document Upload

`upload_document`

📥 Document Download

`download_document`

🔄 Version Control

`checkout_document`

`checkin_document`

`cancel_checkout`

🗑️ Node Deletion

`delete_node`

⚙️ Property Management

`get_node_properties`

`update_node_properties`

📁 Folder Operations

`create_folder`

📚 Resources

Repository Resources

💭 Prompts

`search_and_analyze`

🔍 Error Handling

📄 Resources

`repository_info` (Resource) {#repository_info_resource}

📊 Rate Limits and Performance

🔐 Security Considerations

FilesExpand file tree

api_reference.md

Latest commit

History

api_reference.md

File metadata and controls

API Reference

📋 Overview

Quick Reference

🔍 Search Tools

search_content

advanced_search

search_by_metadata

cmis_search

🗂️ Repository Operations

browse_repository

repository_info

📤 Document Upload

upload_document

📥 Document Download

download_document

🔄 Version Control

checkout_document

checkin_document

cancel_checkout

🗑️ Node Deletion

delete_node

⚙️ Property Management

get_node_properties

update_node_properties

📁 Folder Operations

create_folder

📚 Resources

Repository Resources

💭 Prompts

search_and_analyze

🔍 Error Handling

📄 Resources

repository_info (Resource) {#repository_info_resource}

📊 Rate Limits and Performance

🔐 Security Considerations

`search_content`

`advanced_search`

`search_by_metadata`

`cmis_search`

`browse_repository`

`repository_info`

`upload_document`

`download_document`

`checkout_document`

`checkin_document`

`cancel_checkout`

`delete_node`

`get_node_properties`

`update_node_properties`

`create_folder`

`search_and_analyze`

`repository_info` (Resource) {#repository_info_resource}