Skip to main content
Glama
delano
by delano

create_update_schema_file

Create or update a schema file for a specific API and schema by providing the file path and content. Optionally mark the file as root for protobuf.

Instructions

Create or update a schema file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiIdYesAPI ID
schemaIdYesSchema ID
filePathYesPath to the schema file
contentYesFile content
rootNo

Implementation Reference

  • Executes the tool logic: validates required params (apiId, schemaId, filePath, content), then makes a PUT request to create/update the schema file.
    async createUpdateSchemaFile(args: any): Promise<ToolCallResponse> {
      if (!args.apiId || !args.schemaId || !args.filePath || !args.content) {
        throw new McpError(ErrorCode.InvalidParams, 'apiId, schemaId, filePath, and content are required');
      }
      const { apiId, schemaId, filePath, ...data } = args;
      const response = await this.client.put(
        `/apis/${apiId}/schemas/${schemaId}/files/${filePath}`,
        data
      );
      return this.createResponse(response.data);
    }
  • Routes the tool name 'create_update_schema_file' to the createUpdateSchemaFile handler method.
    case 'create_update_schema_file':
      return await this.createUpdateSchemaFile(args);
  • Schema definition for the tool: specifies name, description, and input schema with apiId, schemaId, filePath (required) and content, root as optional.
    {
      name: 'create_update_schema_file',
      description: 'Create or update a schema file',
      inputSchema: {
        type: 'object',
        properties: {
          apiId: {
            type: 'string',
            description: 'API ID',
          },
          schemaId: {
            type: 'string',
            description: 'Schema ID',
          },
          filePath: {
            type: 'string',
            description: 'Path to the schema file',
          },
          content: {
            type: 'string',
            description: 'File content',
          },
          root: {
            type: 'object',
            properties: {
              enabled: {
                type: 'boolean',
                description: 'Tag as root file (protobuf only)',
              },
            },
          },
        },
        required: ['apiId', 'schemaId', 'filePath', 'content'],
      },
    },
Behavior2/5

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

No annotations provided, so description carries full burden. 'Create or update' implies mutation, but no details on side effects, permissions required, or whether updates are additive or overwriting.

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

Conciseness3/5

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

The description is very brief (one sentence) and lacks detail to be truly helpful. While concise, it does not earn its place by adding sufficient value.

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 5 parameters including a nested object, and no output schema, the description is insufficient. It does not explain how parameters relate, the role of 'root.enabled', or expected return behavior.

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?

Input schema covers 80% of parameters with descriptions, but the tool description adds no additional context beyond what the schema already provides. Baseline score is appropriate.

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

Purpose3/5

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

Description states 'Create or update a schema file' which is a verb+resource, but it is vague and does not differentiate from sibling tools like 'create_api_schema' or 'sync_collection_with_schema'. The meaning of 'schema file' in this context is unclear.

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?

No guidance on when to use this tool versus alternatives such as 'create_api_schema' or 'delete_schema_file'. It does not specify prerequisites or scenarios where this tool is appropriate.

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/delano/postman-mcp-server'

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