Skip to main content
Glama

Beancount.io

Add Structured Ledger Entries

addLedgerEntries

Append entries [{type,entry}]. Supports transaction, commodity, price, note, balance, open, close, pad, budget, document, event. Budget interval uses lowercase daily/weekly/monthly/quarterly/yearly. One posting per transaction may omit its amount and is written elided. An unbalanced transaction is refused with UNBALANCED, and entries that would add bean-check errors (a second open for an open account, a balance against an unopened account), or a budget for an account the ledger lacks, with VALIDATION_FAILED naming each error, unless allowInvalid records them deliberately. ledger is required unless pinned. The commit message is composed from the entries; there is no message argument. dry_run previews without committing.

Input Schema

NameRequiredDescriptionDefault
dryRunNoAlias of dry_run, as REST and GraphQL spell it.
ledgerNoTarget ledger as owner/name. Required for an unpinned credential; defaults to the credential's ledger restriction.
dry_runNoRun every check and return the preview without committing
entriesYes
allowInvalidNo
allow_invalidNo

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / allow_invalid
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / dryRun
      Added value: +{
      +  "description": "Alias of dry_run, as REST and GraphQL spell it.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "description": "Run every check and return the preview without committing",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / entries / items / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "date": {
      -            "type": "string"
      -          },
      -          "flag": {
      -            "type": "string"
      -          },
      -          "links": {
      -            "anyOf": [
      -              {
      -                "items": {
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "meta": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": {
      -                  "type": "string"
      -                },
      -                "propertyNames": {
      -                  "type": "string"
      -                },
      -                "type": "object"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "narration": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "payee": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "postings": {
      -            "items": {
      -              "additionalProperties": false,
      -              "properties": {
      -                "account": {
      -                  "type": "string"
      -                },
      -                "flag": {
      -                  "anyOf": [
      -                    {
      -                      "type": "string"
      -                    },
      -                    {
      -                      "type": "null"
      -                    }
      -                  ]
      -                },
      -                "price": {
      -                  "anyOf": [
      -                    {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "currency": {
      -                          "type": "string"
      -                        },
      -                        "number": {
      -                          "type": "string"
      -                        }
      -                      },
      -                      "required": [
      -                        "number",
      -                        "currency"
      -                      ],
      -                      "type": "object"
      -                    },
      -                    {
      -                      "type": "null"
      -                    }
      -                  ]
      -                },
      -                "units": {
      -                  "anyOf": [
      -                    {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "currency": {
      -                          "type": "string"
      -                        },
      -                        "number": {
      -                          "type": "string"
      -                        }
      -                      },
      -                      "required": [
      -                        "number",
      -                        "currency"
      -                      ],
      -                      "type": "object"
      -                    },
      -                    {
      -                      "type": "null"
      -                    }
      -                  ]
      -                }
      -              },
      -              "required": [
      -                "account"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          "tags": {
      -            "anyOf": [
      -              {
      -                "items": {
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "flag",
      -          "postings"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "transaction",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "currencies": {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account",
      -          "currencies"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "open",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "close",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "amount": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "currency": {
      -                "type": "string"
      -              },
      -              "number": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "number",
      -              "currency"
      -            ],
      -            "type": "object"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account",
      -          "amount"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "balance",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "amount": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "currency": {
      -                "type": "string"
      -              },
      -              "number": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "number",
      -              "currency"
      -            ],
      -            "type": "object"
      -          },
      -          "currency": {
      -            "type": "string"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "currency",
      -          "amount"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "price",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "currency": {
      -            "type": "string"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "currency"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "commodity",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "content": {
      -            "type": "string"
      -          },
      -          "date": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account",
      -          "content"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "note",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "amount": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "currency": {
      -                "type": "string"
      -              },
      -              "number": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "number",
      -              "currency"
      -            ],
      -            "type": "object"
      -          },
      -          "date": {
      -            "type": "string"
      -          },
      -          "interval": {
      -            "enum": [
      -              "daily",
      -              "weekly",
      -              "monthly",
      -              "quarterly",
      -              "yearly"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account",
      -          "interval",
      -          "amount"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "budget",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "account": {
      -            "type": "string"
      -          },
      -          "date": {
      -            "type": "string"
      -          },
      -          "filename": {
      -            "type": "string"
      -          },
      -          "links": {
      -            "anyOf": [
      -              {
      -                "items": {
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "tags": {
      -            "anyOf": [
      -              {
      -                "items": {
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "account",
      -          "filename"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "document",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entry": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "date": {
      -            "type": "string"
      -          },
      -          "description": {
      -            "type": "string"
      -          },
      -          "type": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "date",
      -          "type",
      -          "description"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "event",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "entry"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "date": {
      +            "type": "string"
      +          },
      +          "flag": {
      +            "type": "string"
      +          },
      +          "links": {
      +            "anyOf": [
      +              {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "meta": {
      +            "anyOf": [
      +              {
      +                "additionalProperties": {
      +                  "type": "string"
      +                },
      +                "propertyNames": {
      +                  "type": "string"
      +                },
      +                "type": "object"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "narration": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "payee": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "postings": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "account": {
      +                  "type": "string"
      +                },
      +                "cost": {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "currency": {
      +                          "type": "string"
      +                        },
      +                        "date": {
      +                          "anyOf": [
      +                            {
      +                              "type": "string"
      +                            },
      +                            {
      +                              "type": "null"
      +                            }
      +                          ]
      +                        },
      +                        "label": {
      +                          "anyOf": [
      +                            {
      +                              "type": "string"
      +                            },
      +                            {
      +                              "type": "null"
      +                            }
      +                          ]
      +                        },
      +                        "number": {
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "number",
      +                        "currency"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "flag": {
      +                  "anyOf": [
      +                    {
      +                      "type": "string"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "links": {
      +                  "anyOf": [
      +                    {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "meta": {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": {
      +                        "type": "string"
      +                      },
      +                      "propertyNames": {
      +                        "type": "string"
      +                      },
      +                      "type": "object"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "price": {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "currency": {
      +                          "type": "string"
      +                        },
      +                        "number": {
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "number",
      +                        "currency"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "tags": {
      +                  "anyOf": [
      +                    {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "totalPrice": {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "currency": {
      +                          "type": "string"
      +                        },
      +                        "number": {
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "number",
      +                        "currency"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "units": {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "currency": {
      +                          "type": "string"
      +                        },
      +                        "number": {
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "number",
      +                        "currency"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "account"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "tags": {
      +            "anyOf": [
      +              {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "flag",
      +          "postings"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "transaction",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "booking": {
      +            "anyOf": [
      +              {
      +                "enum": [
      +                  "STRICT",
      +                  "FIFO",
      +                  "LIFO",
      +                  "NONE"
      +                ],
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "currencies": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "date": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "currencies"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "open",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "close",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          },
      +          "sourceAccount": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "sourceAccount"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "pad",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "amount": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "currency": {
      +                "type": "string"
      +              },
      +              "number": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "number",
      +              "currency"
      +            ],
      +            "type": "object"
      +          },
      +          "date": {
      +            "type": "string"
      +          },
      +          "tolerance": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "amount"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "balance",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "amount": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "currency": {
      +                "type": "string"
      +              },
      +              "number": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "number",
      +              "currency"
      +            ],
      +            "type": "object"
      +          },
      +          "currency": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "currency",
      +          "amount"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "price",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "currency": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "currency"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "commodity",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "content": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "content"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "note",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "amount": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "currency": {
      +                "type": "string"
      +              },
      +              "number": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "number",
      +              "currency"
      +            ],
      +            "type": "object"
      +          },
      +          "date": {
      +            "type": "string"
      +          },
      +          "interval": {
      +            "enum": [
      +              "daily",
      +              "weekly",
      +              "monthly",
      +              "quarterly",
      +              "yearly"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "interval",
      +          "amount"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "budget",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "account": {
      +            "type": "string"
      +          },
      +          "date": {
      +            "type": "string"
      +          },
      +          "filename": {
      +            "type": "string"
      +          },
      +          "links": {
      +            "anyOf": [
      +              {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "tags": {
      +            "anyOf": [
      +              {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "account",
      +          "filename"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "document",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "entry": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "date": {
      +            "type": "string"
      +          },
      +          "description": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "date",
      +          "type",
      +          "description"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "event",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "entry"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedOutput schema / properties / result / properties / dry_run
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / result / properties / preview
      Added value: +{
      +  "description": "Per-file entry text; populated on dry runs only",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "path": {
      +        "type": "string"
      +      },
      +      "text": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path",
      +      "text"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / result / required
      Previous value: -[
      -  "summary",
      -  "success",
      -  "wrote",
      -  "entryHashes",
      -  "validation"
      -]New value: +[
      +  "summary",
      +  "success",
      +  "dry_run",
      +  "preview",
      +  "wrote",
      +  "entryHashes",
      +  "validation"
      +]
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Goes well beyond the annotations by naming the failure modes (UNBALANCED, VALIDATION_FAILED) and the exact conditions that trigger them, plus the escape hatch via allowInvalid. It also discloses that the commit message is derived from the entries and that one posting may be elided. Minor gap: no statement on whether the batch is atomic when a mid-list entry fails.

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?

One dense paragraph that front-loads the core action and the entry-type list, then moves to constraints and errors. Every sentence carries information, though the validation clause is packed into a single run-on sentence that is harder to parse than necessary.

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

Completeness4/5

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

For a 6-parameter mutation with an output schema present, this covers behavior, error codes, auth/pinning prerequisites, and preview mode. It leaves only batch atomicity and the alias parameters unaddressed, both of which the schema or output schema partially absorb.

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

Parameters4/5

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

With only 50% schema description coverage, the description compensates well: it explains allowInvalid's purpose, ledger's pinned-credential default, dry_run's preview semantics, and the lowercase budget interval values. It does not document the dryRun/allow_invalid alias parameters, which the schema does cover.

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?

States a specific verb (append) and resource (ledger entries) and enumerates the ten entry types accepted, which is far more than restating the name. It does not explicitly distinguish itself from the sibling appendLedgerText, so an agent must infer the structured-vs-raw split from the title alone.

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

Usage Guidelines3/5

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

Useful conditions are given: ledger is required unless the credential is pinned, and dry_run previews without committing. However, it never says when to prefer this over appendLedgerText or the other write siblings, leaving the main routing decision to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.