get-object
Retrieve objects from Amazon S3 buckets using bucket name and object key to access stored files and data.
Instructions
Retrieve an object from an S3 bucket
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bucket | Yes | Name of the S3 bucket | |
| key | Yes | Key (path) of the object to retrieve |
Implementation Reference
- src/tools/getObject.ts:43-76 (handler)The execute method implements the core logic of the get-object tool: retrieves the S3 object using the injected S3Resource, handles text and binary content, and returns MCP-formatted content or error response.async execute(args: InferZodParams<typeof this.parameters>) { const { bucket, key } = args; try { const result = await this.s3Resource.getObject(bucket, key); // For text content, return as text if (typeof result.data === "string") { return { content: [ { type: "text" as const, text: result.data, }, ], }; } // For binary content, return as base64-encoded string return { content: [ { type: "text" as const, text: `Binary content (${result.contentType}): base64 data is ${result.data.toString("base64").substring(0, 100)}...`, }, ], }; } catch (error) { return createErrorResponse( error, `Error getting object ${key} from bucket ${bucket}: ${error instanceof Error ? error.message : String(error)}`, ); } }
- src/tools/getObject.ts:13-26 (schema)Tool metadata: name, description, and Zod-based input schema for bucket and key parameters.readonly name = "get-object"; /** * Tool description */ readonly description = "Retrieve an object from an S3 bucket"; /** * Parameter definition */ readonly parameters = { bucket: z.string().describe("Name of the S3 bucket"), key: z.string().describe("Key (path) of the object to retrieve"), } as const;
- src/tools/index.ts:12-18 (registration)Factory function that instantiates and returns all tools, including the GetObjectTool with injected S3Resource.export function createTools(s3Resource: S3Resource): IMCPTool[] { return [ new ListBucketsTool(s3Resource), new ListObjectsTool(s3Resource), new GetObjectTool(s3Resource), ]; }
- src/server.ts:27-31 (registration)Calls createTools to get tool instances and registers each on the MCP server via server.tool(name, description, parameters, execute).// Create and register all tools const tools = createTools(s3Resource); for (const tool of tools) { server.tool(tool.name, tool.description, tool.parameters, tool.execute.bind(tool)); }