Muestra de Protocolo de Servidor del Modelo S3

¿Qué es el Servidor MCP de Muestra S3?

El ### Servidor MCP de Muestra S3 es un repositorio público alojado en GitHub bajo la organización ### aws-samples. Este proyecto sirve como una demostración de cómo implementar un servidor que interactúa con Amazon S3 (Servicio de Almacenamiento Simple), mostrando las mejores prácticas y proporcionando código de ejemplo para desarrolladores que buscan integrar S3 en sus aplicaciones. El repositorio incluye varios recursos, incluidos fragmentos de código, documentación y ejemplos que ayudan a los usuarios a entender cómo utilizar S3 de manera efectiva para soluciones de almacenamiento.

Características del Servidor MCP de Muestra S3

• Integración con Amazon S3: El proyecto proporciona una forma fluida de conectarse e interactuar con S3, permitiendo a los usuarios subir, descargar y gestionar archivos sin esfuerzo.
• Acceso Público: Al ser un repositorio público, permite a los desarrolladores acceder al código, contribuir y aprender de los ejemplos proporcionados.
• Documentación: Se incluye documentación completa para guiar a los usuarios a través de la configuración y el uso del servidor.
• Soporte de la Comunidad: Como parte de los ejemplos de AWS, se beneficia de las contribuciones y comentarios de la comunidad, mejorando su funcionalidad y usabilidad.
• Código Abierto: El proyecto es de código abierto, lo que permite a los desarrolladores modificar y adaptar el código para ajustarse a sus necesidades específicas.

Cómo Usar el Servidor MCP de Muestra S3

1. Clona el Repositorio: Comienza clonando el repositorio en tu máquina local usando el comando:

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

2. Configura las Credenciales de AWS: Asegúrate de tener tus credenciales de AWS configuradas. Esto se puede hacer configurando la CLI de AWS o proporcionando credenciales en la configuración de la aplicación.

3. Instala Dependencias: Navega al directorio del proyecto e instala las dependencias requeridas. Esto generalmente implica ejecutar:

   npm install
   

4. Ejecuta el Servidor: Inicia el servidor usando el comando:

   npm start
   

5. Accede a la Aplicación: Una vez que el servidor esté en funcionamiento, puedes acceder a la aplicación a través de tu navegador web o cliente API para interactuar con S3.

6. Explora el Código: Revisa los ejemplos y la documentación proporcionados para entender cómo implementar varias características y funcionalidades.

Preguntas Frecuentes

¿Qué es Amazon S3?

Amazon S3 (Servicio de Almacenamiento Simple) es un servicio de almacenamiento de objetos escalable ofrecido por AWS que permite a los usuarios almacenar y recuperar cualquier cantidad de datos desde cualquier lugar en la web. Se utiliza ampliamente para copias de seguridad, archivado y almacenamiento de datos para aplicaciones web.

¿Es gratuito usar el Servidor MCP de Muestra S3?

Sí, el Servidor MCP de Muestra S3 es un proyecto de código abierto y es gratuito para usar. Sin embargo, puedes incurrir en costos asociados con el uso de servicios de AWS como S3 dependiendo de tu uso.

¿Puedo contribuir al Servidor MCP de Muestra S3?

¡Absolutamente! Las contribuciones son bienvenidas. Puedes bifurcar el repositorio, hacer tus cambios y enviar una solicitud de extracción para revisión.

¿Dónde puedo encontrar más información sobre AWS S3?

Puedes encontrar más información sobre AWS S3 en la documentación oficial de AWS. Esto incluye guías detalladas, referencias de API y mejores prácticas para usar S3 de manera efectiva.

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.