Sample S3 Model Context Protocol Server

Sample S3 Model Context Protocol Server

By aws-samples GitHub

-

Overview

What is Sample S3 Model Context Protocol Server?

The Sample S3 Model Context Protocol Server is an implementation designed to retrieve data, specifically PDF documents, from AWS S3 storage using the Model Context Protocol (MCP).

How to use Sample S3 Model Context Protocol Server?

To use the server, set up your AWS credentials, configure the server settings, and run the server to expose S3 data through defined resources.

Key features of Sample S3 Model Context Protocol Server?

  • Exposes AWS S3 data through resources, acting like GET endpoints.
  • Supports retrieval of PDF documents from S3, limited to 1000 objects.
  • Provides tools for listing buckets and objects, and retrieving specific objects from S3.

Use cases of Sample S3 Model Context Protocol Server?

  1. Accessing and retrieving PDF documents stored in S3 for data analysis.
  2. Integrating S3 data retrieval into applications using the Model Context Protocol.
  3. Facilitating the development of AI models that require access to external data sources.

FAQ from Sample S3 Model Context Protocol Server?

  • What types of documents can be retrieved?

Currently, only PDF documents are supported.

  • How do I configure my AWS credentials?

Obtain your AWS access key ID, secret access key, and region from the AWS Management Console and configure them in your credentials files.

  • Is there a limit to the number of objects I can retrieve?

Yes, the server currently supports a limit of 1000 objects.

Content

Sample S3 Model Context Protocol Server

An MCP server implementation for retrieving data such as PDF's from S3.

Features

Resources

Expose AWS S3 Data through Resources. (think of these sort of like GET endpoints; they are used to load information into the LLM's context). Currently only PDF documents supported and limited to 1000 objects.

Tools

  • ListBuckets
    • Returns a list of all buckets owned by the authenticated sender of the request
  • ListObjectsV2
    • Returns some or all (up to 1,000) of the objects in a bucket with each request
  • GetObject
    • Retrieves an object from Amazon S3. In the GetObject request, specify the full key name for the object. General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported

Configuration

Setting up AWS Credentials

  1. Obtain AWS access key ID, secret access key, and region from the AWS Management Console and configure credentials files using Default profile as shown here
  2. Ensure these credentials have appropriate permission READ/WRITE permissions for S3.

Usage with Claude Desktop

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration 
{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/user/generative_ai/model_context_protocol/s3-mcp-server",
        "run",
        "s3-mcp-server"
      ]
    }
  }
}
Published Servers Configuration 
{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uvx",
      "args": [
        "s3-mcp-server"
      ]
    }
  }
}

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /Users/user/generative_ai/model_context_protocol/s3-mcp-server run s3-mcp-server

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

No tools information available.
No content found.