Skip to main content
Glama

update_document

Modify existing ERPNext documents like customers or items by specifying the document type, name, and updated data fields.

Instructions

Update an existing document in ERPNext

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doctypeYesERPNext DocType (e.g., Customer, Item)
nameYesDocument name/ID
dataYesDocument data to update

Implementation Reference

  • MCP CallToolRequestSchema handler case for 'update_document': checks authentication, validates arguments (doctype, name, data), invokes erpnext.updateDocument, and returns formatted success/error response.
    case "update_document": {
      if (!erpnext.isAuthenticated()) {
        return {
          content: [{
            type: "text",
            text: "Not authenticated with ERPNext. Please configure API key authentication."
          }],
          isError: true
        };
      }
      
      const doctype = String(request.params.arguments?.doctype);
      const name = String(request.params.arguments?.name);
      const data = request.params.arguments?.data as Record<string, any> | undefined;
      
      if (!doctype || !name || !data) {
        throw new McpError(
          ErrorCode.InvalidParams,
          "Doctype, name, and data are required"
        );
      }
      
      try {
        const result = await erpnext.updateDocument(doctype, name, data);
        return {
          content: [{
            type: "text",
            text: `Updated ${doctype} ${name}\n\n${JSON.stringify(result, null, 2)}`
          }]
        };
      } catch (error: any) {
        return {
          content: [{
            type: "text",
            text: `Failed to update ${doctype} ${name}: ${error?.message || 'Unknown error'}`
          }],
          isError: true
        };
      }
    }
  • Core ERPNextClient.updateDocument method: executes the HTTP PUT request to the ERPNext REST API endpoint `/api/resource/{doctype}/{name}` with the provided document data.
    async updateDocument(doctype: string, name: string, doc: Record<string, any>): Promise<any> {
      try {
        const response = await this.axiosInstance.put(`/api/resource/${doctype}/${name}`, {
          data: doc
        });
        return response.data.data;
      } catch (error: any) {
        throw new Error(`Failed to update ${doctype} ${name}: ${error?.message || 'Unknown error'}`);
      }
    }
  • Tool specification in ListToolsRequestSchema response: defines name, description, and input schema (doctype, name, data as object) for the update_document tool.
      name: "update_document",
      description: "Update an existing document in ERPNext",
      inputSchema: {
        type: "object",
        properties: {
          doctype: {
            type: "string",
            description: "ERPNext DocType (e.g., Customer, Item)"
          },
          name: {
            type: "string",
            description: "Document name/ID"
          },
          data: {
            type: "object",
            additionalProperties: true,
            description: "Document data to update"
          }
        },
        required: ["doctype", "name", "data"]
      }
    },
  • src/index.ts:324-442 (registration)
    Registration of all tools including 'update_document' via the ListToolsRequestSchema handler, which lists available tools with their schemas.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: [
          {
            name: "get_doctypes",
            description: "Get a list of all available DocTypes",
            inputSchema: {
              type: "object",
              properties: {}
            }
          },
          {
            name: "get_doctype_fields",
            description: "Get fields list for a specific DocType",
            inputSchema: {
              type: "object",
              properties: {
                doctype: {
                  type: "string",
                  description: "ERPNext DocType (e.g., Customer, Item)"
                }
              },
                required: ["doctype"]
            }
          },
          {
            name: "get_documents",
            description: "Get a list of documents for a specific doctype",
            inputSchema: {
              type: "object",
              properties: {
                doctype: {
                  type: "string",
                  description: "ERPNext DocType (e.g., Customer, Item)"
                },
                fields: {
                  type: "array",
                  items: {
                    type: "string"
                  },
                  description: "Fields to include (optional)"
                },
                filters: {
                  type: "object",
                  additionalProperties: true,
                  description: "Filters in the format {field: value} (optional)"
                },
                limit: {
                  type: "number",
                  description: "Maximum number of documents to return (optional)"
                }
              },
              required: ["doctype"]
            }
          },
          {
            name: "create_document",
            description: "Create a new document in ERPNext",
            inputSchema: {
              type: "object",
              properties: {
                doctype: {
                  type: "string",
                  description: "ERPNext DocType (e.g., Customer, Item)"
                },
                data: {
                  type: "object",
                  additionalProperties: true,
                  description: "Document data"
                }
              },
              required: ["doctype", "data"]
            }
          },
          {
            name: "update_document",
            description: "Update an existing document in ERPNext",
            inputSchema: {
              type: "object",
              properties: {
                doctype: {
                  type: "string",
                  description: "ERPNext DocType (e.g., Customer, Item)"
                },
                name: {
                  type: "string",
                  description: "Document name/ID"
                },
                data: {
                  type: "object",
                  additionalProperties: true,
                  description: "Document data to update"
                }
              },
              required: ["doctype", "name", "data"]
            }
          },
          {
            name: "run_report",
            description: "Run an ERPNext report",
            inputSchema: {
              type: "object",
              properties: {
                report_name: {
                  type: "string",
                  description: "Name of the report"
                },
                filters: {
                  type: "object",
                  additionalProperties: true,
                  description: "Report filters (optional)"
                }
              },
              required: ["report_name"]
            }
          }
        ]
      };
    });

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden. It implies mutation but does not disclose whether updates are partial or full replacements, idempotency, error behavior, or required permissions. This is a significant gap for a write operation.

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

Conciseness4/5

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

The description is a single, concise sentence that front-loads the verb and resource. It is appropriately short but could be easily expanded with key details without losing brevity.

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 has three required parameters, a nested data object, and no output schema, the description is too sparse. It does not explain return values, partial update behavior, or how the data object should be structured beyond the schema. The description is inadequate for a mutation tool without annotations.

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?

The input schema has 100% coverage, with clear descriptions for each parameter (doctype, name, data). The description adds no additional parameter-level meaning, so the baseline of 3 is appropriate since 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 states the specific verb 'Update' and resource 'existing document in ERPNext,' which clearly distinguishes it from sibling tools like create_document or get_documents. However, it lacks detail on what kind of document or which fields can be updated, but it is not misleading.

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 is given on when to use this tool versus alternatives. It does not explain prerequisites, differences from create_document, or any exclusions. The description simply states the operation without context.

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