Building a Data Stack Live with AI AgentsLivestream August 18

Skip to main content

update_guide_metadata

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

Change a Guide's title, description, or topic without appending a content version. The guide keeps its UUID and full version history.

Description​

The update_guide_metadata tool lets you retitle or re-topic a guide without touching its content. Use it when a guide's title or grouping is outdated — for example after a team reorganization or a product rename.

Provide at least one of title, description, or topic.

To update content, use update_guide or edit_guide_content instead.

Input parameters​

ParameterTypeRequiredDescription
uuidstringYesThe guide's UUID, as returned by list_guides or a previous mutation.
titlestringNoNew human-readable title. Must not be empty when supplied.
descriptionstringNoNew one-line summary. Pass an empty string ("") to clear it.
topicstringNoNew grouping label — for example "revenue-billing" or "core/metrics" (no leading or trailing slash). Pass an empty string ("") to remove the topic.

Output schema​

{
  "success": boolean,
  "guide": {
    "id": string,
    "topic": string,           // Updated topic (null when cleared)
    "title": string,           // Updated title
    "description": string,     // Updated description
    "access": string,
    "current_version": number,
    "created_at": string,
    "updated_at": string
  },
  "error": string
}

Example usage​

Move a guide to a different topic:

Move the order filters guide from order-management to customer-orders
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "topic": "customer-orders",
  "title": "Customer Order Filters"
}

Update only the description:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "MRR and ARR definitions, including expansion and churn adjustments"
}

Remove the topic (move the guide to the root level):

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "topic": ""
}