Esempio di Protocollo Server del Modello S3
Panoramica
Cos'è il Sample MCP Server S3?
Il ### Sample MCP Server S3 è un repository pubblico ospitato su GitHub sotto l'organizzazione ### aws-samples. Questo progetto serve come dimostrazione di come implementare un server che interagisce con Amazon S3 (Simple Storage Service), mostrando le migliori pratiche e fornendo codice di esempio per gli sviluppatori che desiderano integrare S3 nelle loro applicazioni. Il repository include varie risorse, tra cui frammenti di codice, documentazione ed esempi che aiutano gli utenti a comprendere come utilizzare efficacemente S3 per soluzioni di archiviazione.
Caratteristiche del Sample MCP Server S3
- Integrazione con Amazon S3: Il progetto fornisce un modo semplice per connettersi e interagire con S3, consentendo agli utenti di caricare, scaricare e gestire file senza sforzo.
- Accesso Pubblico: Essendo un repository pubblico, consente agli sviluppatori di accedere al codice, contribuire e apprendere dagli esempi forniti.
- Documentazione: È inclusa una documentazione completa per guidare gli utenti attraverso la configurazione e l'uso del server.
- Supporto della Comunità: Come parte dei campioni AWS, beneficia dei contributi e dei feedback della comunità, migliorando la sua funzionalità e usabilità.
- Open Source: Il progetto è open-source, consentendo agli sviluppatori di modificare e adattare il codice per soddisfare le proprie esigenze specifiche.
Come Utilizzare il Sample MCP Server S3
-
Clona il Repository: Inizia clonando il repository sulla tua macchina locale utilizzando il comando:
git clone https://github.com/aws-samples/sample-mcp-server-s3.git
-
Configura le Credenziali AWS: Assicurati di avere le tue credenziali AWS configurate. Questo può essere fatto configurando l'AWS CLI o fornendo le credenziali nella configurazione dell'applicazione.
-
Installa le Dipendenze: Naviga nella directory del progetto e installa eventuali dipendenze richieste. Questo di solito comporta l'esecuzione di:
npm install
-
Esegui il Server: Avvia il server utilizzando il comando:
npm start
-
Accedi all'Applicazione: Una volta che il server è in esecuzione, puoi accedere all'applicazione tramite il tuo browser web o client API per interagire con S3.
-
Esplora il Codice: Rivedi gli esempi forniti e la documentazione per comprendere come implementare varie funzionalità e caratteristiche.
Domande Frequenti
Cos'è Amazon S3?
Amazon S3 (Simple Storage Service) è un servizio di archiviazione oggetti scalabile offerto da AWS che consente agli utenti di memorizzare e recuperare qualsiasi quantità di dati da qualsiasi luogo sul web. È ampiamente utilizzato per backup, archiviazione e archiviazione di dati per applicazioni web.
Il Sample MCP Server S3 è gratuito da usare?
Sì, il Sample MCP Server S3 è un progetto open-source ed è gratuito da usare. Tuttavia, potresti incorrere in costi associati all'uso dei servizi AWS come S3 a seconda del tuo utilizzo.
Posso contribuire al Sample MCP Server S3?
Assolutamente! I contributi sono benvenuti. Puoi forkare il repository, apportare le tue modifiche e inviare una pull request per la revisione.
Dove posso trovare ulteriori informazioni su AWS S3?
Puoi trovare ulteriori informazioni su AWS S3 nella documentazione ufficiale di AWS. Questo include guide dettagliate, riferimenti API e migliori pratiche per utilizzare S3 in modo efficace.
Dettaglio
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"
]
}
}
}
</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:
- 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:
--token
orUV_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.
Configurazione Server
{
"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": {}
}
}
}