MCP Server Aistor

🚀 AIStor MCP Server Guide

The AIStor MCP (Model Context Protocol) server is a tool for managing and operating the AIStor object storage system. This document provides detailed information about the server's features, configuration, and usage.

✨ Features

1. Read Operations

• List Buckets: Retrieve all buckets in the AIStor storage system and their basic information.
• List Bucket Contents: List all objects in a specified bucket, including file size and last modification time. Supports prefix filtering and version listing.
• Download Objects: Download objects from a specified bucket to the local file system, preserving metadata. Supports downloading by specifying a version ID.

2. AI Operations

• Query Object Content: Use artificial intelligence to analyze the content of a specified object and return context-based answers. Supports multiple file formats.

3. Write Operations

• Upload Objects: Upload local files to a specified bucket, supporting metadata and tag settings.
• Create Buckets: Create new storage buckets and configure version control and other settings.

4. Delete Operations

• Delete Objects: Delete specific objects or a particular version from a specified bucket. Supports soft deletion and allows deletion by specifying a version ID.
• Delete Buckets: Delete a specified bucket and all objects it contains. You can choose to force delete all contents.

5. Copy and Move

• Copy Objects: Copy objects from one bucket to another, preserving metadata. Supports copying by specifying a version ID.
• Move Objects: Move objects from the source bucket to the target bucket, creating a new object at the target and deleting the source object. Supports moving by specifying a version ID.

6. Management Operations

• Get Bucket Lifecycle Rules: View the lifecycle configuration (including Intelligent Lifecycle Management ILM rules) of a specified bucket.
• Get Bucket Replication Configuration: View the replication configuration of a specified bucket.
• Get Bucket Tags: View all tag information of a specified bucket.
• Get Bucket Versioning Status: View the version control status and configuration of a specified bucket.
• Get Storage Usage: Obtain the data usage of the entire AIStor storage system, including total storage, number of objects, and usage by bucket.
• Get Object Metadata: Retrieve detailed metadata of a specified object, including MIME type, size, custom headers, and system properties.
• Get Object Signed URL: Generate a signed URL with an optional expiration time for an object in a specified bucket. The default expiration time is 7 days.
• Get Object Tags: Get all tag information of a specified object.
• Get Object Version List: List all versions of a specified object.

7. Others

• List Allowed Directories: List all operational directories supported by the server.
• List Local Files: List all files and directories and their attributes in a specified local path.

📦 Installation

Configuration

The configuration of the AIStor MCP server is done through a JSON - formatted configuration file. Here is an example configuration:

{
    "allowed_directories": [
        "/path/to/directory1",
        "/path/to/directory2"
    ],
    "buckets": {
        "bucket1": {
            "versioning": true,
            "tags": {
                "tag1": "value1",
                "tag2": "value2"
            }
        },
        "bucket2": {
            "versioning": false
        }
    }
}

💻 Usage Examples

Command List

The following are all the tool commands supported by the AIStor MCP server and their functional descriptions:

• ask - object: Use artificial intelligence to analyze the content of a specified object, support multiple file formats, and return context - based answers.
• copy - object: Copy an object from one bucket to another, preserving metadata. Supports copying by specifying a version ID.
• create - bucket: Create a new storage bucket and configure its attributes and version control settings.
• delete - bucket: Delete a specified bucket and all objects it contains. You can choose to force delete all contents.
• delete - object: Delete a specific object or a particular version from a specified bucket. Supports soft deletion and allows deletion by specifying a version ID.
• download - object: Download an object from a specified bucket to the local file system, preserving metadata. Supports downloading by specifying a version ID.
• get - admin - info: Retrieve detailed management information of the AIStor storage system, including the status of all storage nodes, volumes, and buckets.
• get - bucket - lifecycle: Get the lifecycle rule configuration (including Intelligent Lifecycle Management ILM rules) of a specified bucket.
• get - bucket - replication: Get the replication configuration of a specified bucket.
• get - bucket - tags: Get all tag information of a specified bucket.
• get - bucket - versioning: Get the version control status and configuration of a specified bucket.
• get - storage - usage: Obtain the data usage of the entire AIStor storage system, including total storage, number of objects, and usage by bucket.
• get - object - metadata: Retrieve detailed metadata of a specified object, including MIME type, size, custom headers, and system properties.
• get - object - signed - url: Generate a signed URL with an optional expiration time for an object in a specified bucket. The default expiration time is 7 days.
• get - object - tags: Get all tag information of a specified object.
• get - object - versions: List all versions of a specified object.
• list - allowed - directories: List all operational directories supported by the server.
• list - local - files: List all files and directories and their attributes in a specified local path.

⚠️ Important Note

• All operations must comply with AIStor's security policies and permission management specifications.
• Ensure that the paths in the configuration file are absolutely correct to avoid unexpected permission issues or data loss.
• Before performing deletion operations, confirm the irreversibility of the operation and back up your data.

With the above features and commands, you can efficiently manage and operate the AIStor object storage system.