Skip to main content
Glama

putObject

Upload local files to cloud storage buckets by specifying file paths, target directories, and custom filenames for organized cloud file management.

Instructions

上传本地文件到存储桶

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYes文件路径 (包含文件名)
fileNameNo文件名 (存在存储桶里的名称)
targetDirNo目标目录 (存在存储桶的哪个目录)

Implementation Reference

  • Core handler logic for uploading a local file to COS bucket: validates parameters, checks file existence, builds object key, performs upload via cos.uploadFile, handles errors.
    async uploadFile(params: UploadFileParams) {
      // 验证并解析参数
      const validParams = UploadFileParamsSchema.parse(params);
      const { filePath, targetDir = '', fileName } = validParams;
      try {
        // 检查文件是否存在
        if (!filePath || !fs.existsSync(filePath)) {
          return {
            isSuccess: false,
            message: '此路径上文件不存在',
            data: '此路径上文件不存在: ' + filePath,
          };
        }
        // 确定文件名
        const actualFileName = fileName || path.basename(filePath);
    
        // 构建COS路径
        const cosPath = this.buildCosPath(actualFileName, targetDir);
    
        // 上传文件
        const cosParams: COS.UploadFileParams = {
          Bucket: this.bucket,
          Region: this.region,
          Key: cosPath,
          FilePath: filePath,
        };
    
        const result = await this.cos.uploadFile(cosParams);
    
        return {
          isSuccess: true,
          message: '上传成功',
          data: result,
        };
      } catch (error) {
        return {
          isSuccess: false,
          message: '上传失败',
          data: error,
        };
      }
    }
  • src/server.ts:84-111 (registration)
    Registers the 'putObject' MCP tool, defines input schema with zod, and provides thin handler that delegates to CosService.uploadFile and formats response.
    server.tool(
      'putObject',
      '上传本地文件到存储桶',
      {
        filePath: z.string().describe('文件路径 (包含文件名)'),
        fileName: z.string().optional().describe('文件名 (存在存储桶里的名称)'),
        targetDir: z
          .string()
          .optional()
          .describe('目标目录 (存在存储桶的哪个目录)'),
      },
      async ({ fileName, filePath, targetDir }) => {
        const res = await COSInstance.uploadFile({
          fileName,
          filePath,
          targetDir,
        });
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(res.data, null, 2),
            },
          ],
          isError: !res.isSuccess,
        };
      },
    );
  • Zod schema definition for upload file parameters, used for validation inside the uploadFile handler.
    export const UploadFileParamsSchema = z.object({
      filePath: z.string().optional(),
      targetDir: z.string().optional(),
      fileName: z.string().optional(),
      sourceUrl: z.string().optional()
    });
    export type UploadFileParams = z.infer<typeof UploadFileParamsSchema>;
  • Helper function to construct the full COS object key/path from filename and optional target directory.
    private buildCosPath(fileName: string, targetDir?: string): string {
      if (!targetDir) {
        return fileName;
      }
      
      // 规范化目标目录:移除头尾斜杠
      const normalizedDir = targetDir.replace(/^\/+|\/+$/g, '');
      return normalizedDir ? `${normalizedDir}/${fileName}` : fileName;
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the upload action but doesn't cover critical traits like required permissions, rate limits, error handling (e.g., if file doesn't exist), or what happens on success (e.g., returns a URL or confirmation). For a mutation tool with zero annotation coverage, this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence in Chinese ('上传本地文件到存储桶') that is front-loaded and wastes no words. It directly conveys the core purpose without unnecessary elaboration, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (a mutation with 3 parameters), lack of annotations, and no output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., success status, object URL), error conditions, or behavioral nuances like overwrite policies. For a file upload tool, this leaves critical gaps for an AI agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with clear descriptions for filePath, fileName, and targetDir in Chinese. The description adds no additional meaning beyond the schema, such as format examples (e.g., path syntax) or interdependencies (e.g., fileName defaults to basename of filePath). Baseline 3 is appropriate as the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '上传本地文件到存储桶' clearly states the action (upload) and resource (local file to storage bucket) in Chinese. It distinguishes from siblings like putBase64, putBuffer, putObjectSourceUrl, and putString by specifying 'local file' as the source, though it doesn't explicitly name these alternatives. The purpose is specific but could be more precise about sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like putBase64, putBuffer, putObjectSourceUrl, or putString. It lacks context such as prerequisites (e.g., file must exist locally), performance considerations, or error conditions. Usage is implied by the action but not explicitly stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/xiaomizhoubaobei/MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server