Modelo de Amostra do Protocolo de Contexto do Servidor S3
Visão geral
O que é o Servidor MCP de Amostra S3?
O ### Servidor MCP de Amostra S3 é um repositório público hospedado no GitHub sob a organização ### aws-samples. Este projeto serve como uma demonstração de como implementar um servidor que interage com o Amazon S3 (Serviço de Armazenamento Simples), mostrando as melhores práticas e fornecendo código de exemplo para desenvolvedores que desejam integrar o S3 em suas aplicações. O repositório inclui vários recursos, incluindo trechos de código, documentação e exemplos que ajudam os usuários a entender como usar efetivamente o S3 para soluções de armazenamento.
Recursos do Servidor MCP de Amostra S3
- Integração com o Amazon S3: O projeto fornece uma maneira simples de conectar e interagir com o S3, permitindo que os usuários façam upload, download e gerenciem arquivos sem esforço.
- Acesso Público: Sendo um repositório público, permite que os desenvolvedores acessem o código, contribuam e aprendam com os exemplos fornecidos.
- Documentação: Documentação abrangente está incluída para guiar os usuários na configuração e uso do servidor.
- Suporte da Comunidade: Como parte dos exemplos da AWS, se beneficia de contribuições e feedback da comunidade, melhorando sua funcionalidade e usabilidade.
- Código Aberto: O projeto é de código aberto, permitindo que os desenvolvedores modifiquem e adaptem o código para atender às suas necessidades específicas.
Como Usar o Servidor MCP de Amostra S3
-
Clone o Repositório: Comece clonando o repositório para sua máquina local usando o comando:
git clone https://github.com/aws-samples/sample-mcp-server-s3.git -
Configure as Credenciais da AWS: Certifique-se de que suas credenciais da AWS estão configuradas. Isso pode ser feito configurando o AWS CLI ou fornecendo credenciais na configuração do aplicativo.
-
Instale as Dependências: Navegue até o diretório do projeto e instale quaisquer dependências necessárias. Isso geralmente envolve executar:
npm install -
Execute o Servidor: Inicie o servidor usando o comando:
npm start -
Acesse o Aplicativo: Uma vez que o servidor esteja em execução, você pode acessar o aplicativo através do seu navegador ou cliente de API para interagir com o S3.
-
Explore o Código: Revise os exemplos e a documentação fornecidos para entender como implementar várias funcionalidades e recursos.
Perguntas Frequentes
O que é o Amazon S3?
O Amazon S3 (Serviço de Armazenamento Simples) é um serviço de armazenamento de objetos escalável oferecido pela AWS que permite aos usuários armazenar e recuperar qualquer quantidade de dados de qualquer lugar na web. É amplamente utilizado para backup, arquivamento e armazenamento de dados para aplicações web.
O Servidor MCP de Amostra S3 é gratuito para usar?
Sim, o Servidor MCP de Amostra S3 é um projeto de código aberto e é gratuito para usar. No entanto, você pode incorrer em custos associados ao uso de serviços da AWS como o S3, dependendo do seu uso.
Posso contribuir para o Servidor MCP de Amostra S3?
Absolutamente! Contribuições são bem-vindas. Você pode fazer um fork do repositório, fazer suas alterações e enviar um pull request para revisão.
Onde posso encontrar mais informações sobre o AWS S3?
Você pode encontrar mais informações sobre o AWS S3 na documentação oficial da AWS. Isso inclui guias detalhados, referências de API e melhores práticas para usar o S3 de forma eficaz.
Detalhe
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
- 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
- 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
{
"mcpServers": {
"s3-mcp-server": {
"command": "uv",
"args": [
"--directory",
"/Users/user/generative_ai/model_context_protocol/s3-mcp-server",
"run",
"s3-mcp-server"
]
}
}
}
{
"mcpServers": {
"s3-mcp-server": {
"command": "uvx",
"args": [
"s3-mcp-server"
]
}
}
}
Development
Building and Publishing
To prepare the package for distribution:
- Sync dependencies and update lockfile:
uv sync
- Build package distributions:
uv build
This will create source and wheel distributions in the dist/ directory.
- Publish to PyPI:
uv publish
Note: You'll need to set PyPI credentials via environment variables or command flags:
- Token:
--tokenorUV_PUBLISH_TOKEN - Or username/password:
--username/UV_PUBLISH_USERNAMEand--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.
Configuração do Servidor
{
"mcpServers": {
"sample-mcp-server-s-3": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/metorial/mcp-container--aws-samples--sample-mcp-server-s3--sample-mcp-server-s-3",
"s3-mcp-server"
],
"env": {}
}
}
}