Do AI Agents Need a Semantic Layer?Livestream August 26

Skip to main content

update_guide

Preview
This feature is in preview and is subject to change.

Append a version to an existing Guide, identified by UUID. Use this to replace a Guide's full content. For smaller targeted edits, use edit_guide_content instead.

Description​

The update_guide tool saves an updated version of an existing Guide. Omit content to carry the current text forward and only update metadata such as references. A supplied references list replaces the existing one — pass an empty array ([]) to clear all references, or omit references entirely to carry them forward.

To retitle or re-topic a Guide, use update_guide_metadata. To change visibility, use set_guide_access.

Input parameters​

ParameterTypeRequiredDescription
uuidstringYesThe Guide's UUID, as returned by list_guides or a previous mutation.
contentstringNoNew full markdown body. Omit to carry the current version's content forward.
change_commentstringNoOptional note describing this version's change.
external_idstringNoOptional caller-provided ID for this version (for example a git SHA).
referencesarrayNoReplaces the Guide's references. Pass [] to clear; omit to carry forward. See reference object shape.

Output schema​

{
  "success": boolean,
  "guide": {
    "id": string,
    "topic": string,
    "title": string,
    "description": string,
    "access": string,
    "current_version": number,
    "created_at": string,
    "updated_at": string,
    "version_change_comment": string,
    "version_external_id": string,
    "version_created_at": string,
    "references": array
  },
  "error": string
}

Example usage​

Update the full content of a Guide:

Update the MRR guide to clarify that trial subscriptions are excluded
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "content": "# MRR and ARR Definitions\n\n...(updated content)...",
  "change_comment": "Clarify trial subscription exclusion logic"
}

Add references without changing content:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "references": [
    {
      "type": "catalog",
      "url": "md:billing",
      "schema": "main",
      "table": "subscriptions"
    },
    {
      "type": "catalog",
      "url": "md:billing",
      "schema": "main",
      "table": "invoices"
    }
  ]
}

Clear all references:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "references": []
}