Exemple de serveur de protocole de contexte du modèle S3

Qu'est-ce que le Serveur S3 MCP Exemple ?

Le ### Serveur S3 MCP Exemple est un dépôt public hébergé sur GitHub sous l'organisation ### aws-samples. Ce projet sert de démonstration sur la manière de mettre en œuvre un serveur qui interagit avec Amazon S3 (Service de Stockage Simple), mettant en avant les meilleures pratiques et fournissant du code d'exemple pour les développeurs souhaitant intégrer S3 dans leurs applications. Le dépôt comprend diverses ressources, y compris des extraits de code, de la documentation et des exemples qui aident les utilisateurs à comprendre comment utiliser efficacement S3 pour des solutions de stockage.

Caractéristiques du Serveur S3 MCP Exemple

• Intégration avec Amazon S3 : Le projet offre un moyen fluide de se connecter et d'interagir avec S3, permettant aux utilisateurs de télécharger, de télécharger et de gérer des fichiers sans effort.
• Accès Public : Étant un dépôt public, il permet aux développeurs d'accéder au code, de contribuer et d'apprendre des exemples fournis.
• Documentation : Une documentation complète est incluse pour guider les utilisateurs à travers la configuration et l'utilisation du serveur.
• Support Communautaire : En tant que partie des exemples AWS, il bénéficie des contributions et des retours de la communauté, améliorant ainsi sa fonctionnalité et son utilisation.
• Open Source : Le projet est open-source, permettant aux développeurs de modifier et d'adapter le code pour répondre à leurs besoins spécifiques.

Comment utiliser le Serveur S3 MCP Exemple

1. Cloner le Dépôt : Commencez par cloner le dépôt sur votre machine locale en utilisant la commande :

   git clone https://github.com/aws-samples/sample-mcp-server-s3.git
   

2. Configurer les Identifiants AWS : Assurez-vous d'avoir vos identifiants AWS configurés. Cela peut être fait en configurant l'AWS CLI ou en fournissant des identifiants dans la configuration de l'application.

3. Installer les Dépendances : Naviguez jusqu'au répertoire du projet et installez toutes les dépendances requises. Cela implique généralement d'exécuter :

   npm install
   

4. Exécuter le Serveur : Démarrez le serveur en utilisant la commande :

   npm start
   

5. Accéder à l'Application : Une fois le serveur en cours d'exécution, vous pouvez accéder à l'application via votre navigateur web ou client API pour interagir avec S3.

6. Explorer le Code : Consultez les exemples et la documentation fournis pour comprendre comment mettre en œuvre diverses fonctionnalités et fonctionnalités.

Questions Fréquemment Posées

Qu'est-ce qu'Amazon S3 ?

Amazon S3 (Service de Stockage Simple) est un service de stockage d'objets évolutif proposé par AWS qui permet aux utilisateurs de stocker et de récupérer n'importe quelle quantité de données depuis n'importe où sur le web. Il est largement utilisé pour la sauvegarde, l'archivage et le stockage de données pour les applications web.

Le Serveur S3 MCP Exemple est-il gratuit à utiliser ?

Oui, le Serveur S3 MCP Exemple est un projet open-source et est gratuit à utiliser. Cependant, vous pourriez encourir des coûts associés à l'utilisation des services AWS comme S3 en fonction de votre utilisation.

Puis-je contribuer au Serveur S3 MCP Exemple ?

Absolument ! Les contributions sont les bienvenues. Vous pouvez forker le dépôt, apporter vos modifications et soumettre une demande de tirage pour révision.

Où puis-je trouver plus d'informations sur AWS S3 ?

Vous pouvez trouver plus d'informations sur AWS S3 dans la documentation officielle d'AWS. Cela inclut des guides détaillés, des références API et des meilleures pratiques pour utiliser S3 efficacement.

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

<details> <summary>Development/Unpublished Servers Configuration</summary>

{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/user/generative_ai/model_context_protocol/s3-mcp-server",
        "run",
        "s3-mcp-server"
      ]
    }
  }
}

</details> <details> <summary>Published Servers Configuration</summary>

{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uvx",
      "args": [
        "s3-mcp-server"
      ]
    }
  }
}

</details>

Development

Building and Publishing

To prepare the package for distribution:

1. Sync dependencies and update lockfile:

uv sync

2. Build package distributions:

uv build

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

3. 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.