Tiptap Docs

Changelog - Tool definitions

@tiptap-pro/ai-toolkit-tool-definitions

0.4.0

Patch Changes

  • a8ac0a0: Improve the tiptapReadSelection tool so that it uses less tokens and it does not cause the AI to mistake the selected content with the content of the nodes where the selection is located.

0.3.10

0.3.9

0.3.8

0.3.7

Patch Changes

  • 0608c46: Minor bugfixes & improvements

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

Patch Changes

  • 8a7a077: Fix the published CLI so tool-definitions and the workflow commands run correctly when invoked as a package binary.

0.3.1

0.3.0

0.2.3

0.2.2

0.2.1

0.2.0

Minor Changes

  • e3082aa: Standardize tiptapEdit operation reporting around an operationResults array that returns one result per attempted operation, including the target, success state, and any error message.

    Add streamingOptions field to streamTool and tiptapEditWorkflow, to customize how content is streamed.

    Show a "typing effect" when streaming content in review mode or in preview mode. This "typing effect" can be disabled by configuring streamingOptions.disableTypingEffect.

    Add Tracked Changes support to the Tiptap Edit workflow and the Proofreader workflow.

    Add streaming support when using the AI Toolkit with Tracked Changes. When streaming content with tracked changes, streaming support does not show a "typing effect". Instead, it streams content on a per-operation basis.

    Breaking changes:

    • The tiptapEdit tool output now includes the operationResults property instead of successful and failed.
    • tiptapEditWorkflow now returns operationResults instead of successful and failed.
    • proofreaderWorkflow now returns operationResults instead of operations.

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Minor Changes

  • e214bc6: Start a new versioning scheme that aligns all AI toolkit and server AI toolkit packages on the same version.

3.0.0-alpha.36

Major Changes

  • Requires @tiptap-pro/ai-toolkit package version 3.0.0-alpha.88 or later.
  • Rename hash to target in the proofreader workflow, for consistency with edit operations

Minor Changes

  • Improve prompts of tools and workflows to avoid unnecessary document reads.

3.0.0-alpha.35

Minor Changes

  • Add requiredSlots, requiredConditions, and requiredAttributes options to createTemplateWorkflow. When omitted, all fields are required (the default). Pass an empty array to make all fields of a type optional.

3.0.0-alpha.34

Minor Changes

  • Add CLI utility. The package can now be used as a command-line tool via npx @tiptap-pro/ai-toolkit-tool-definitions. Available commands: tool-definitions, tiptap-edit-workflow, proofreader-workflow, template-workflow, edit-threads-workflow, and insert-content-workflow. Each command outputs JSON to stdout.

3.0.0-alpha.33

Minor Changes

  • Add optional context field to the user prompt of createProofreaderWorkflow, createTemplateWorkflow, and createTiptapEditWorkflow workflows. This field allows developers to provide additional background information related to the task.

3.0.0-alpha.32

Patch Changes

  • Clarify template workflow prompt to indicate that slot content replaces the entire slot element.

3.0.0-alpha.31

Minor Changes

  • Add createTemplateWorkflow server-side workflow for generating template-filling prompts and schemas.

3.0.0-alpha.30

Minor Changes

  • Add operationMeta option to toolDefinitions() and tiptapEditTool(). When set, the AI includes a meta field in each edit operation with an explanation of why the change was made.

3.0.0-alpha.29

Major Changes

  • Improve tool definition of editThreads tool to avoid errors where the AI would sometimes fail to create threads.
  • Improve prompt of the Comments workflow to avoid errors where the AI would sometimes fail to create threads.

3.0.0-alpha.28

Patch Changes

  • Improved the tool definition of tiptapEdit to make edits more efficient.

3.0.0-alpha.27

Major Changes

  • Breaking: Rename nodes input property to content in workflow user prompts. This affects createTiptapEditWorkflow and createEditThreadsWorkflow. Update your workflow calls to use content instead of nodes.

Patch Changes

  • Update editThreadsWorkflow to clarify that htmlContent must include the entire node HTML, including the HTML tag of that node.
  • Update editThreads tool description to clarify HTML content requirements.

3.0.0-alpha.26

Patch Changes

  • Clarify getThreads pagination range to use an exclusive upper bound in tool output.

3.0.0-alpha.25

Patch Changes

  • Add pagination fields to the getThreads tool schema and description.

3.0.0-alpha.24

Major Changes

  • Breaking: Remove server tool definitions and exports from this package.

3.0.0-alpha.23

Minor Changes

  • Add createTiptapEditWorkflow method. This method creates the prompt and schema for a built-in workflow that allows the AI to edit the document.
  • Add createEditThreadsWorkflow method. This method creates the prompt and schema for a built-in workflow that allows the AI to manage comments and threads.

3.0.0-alpha.22

Major Changes

  • Breaking: Change editThreads tool to use a new, more efficient format. The new format is faster, more efficient, uses fewer tokens, and avoids diff mismatch errors completely, significantly improving the accuracy of the tool.

3.0.0-alpha.21

Minor Changes

  • Include Zod schemas in tool definitions, in the zodInputSchema property.

3.0.0-alpha.20

Minor Changes

  • Add createInsertContentWorkflow method. This method creates the prompt for a built-in workflow that allows the AI to insert or replace content in the document.

3.0.0-alpha.19

Minor Changes

  • Add createProofreaderWorkflow method. This method creates the prompt and schema for a built-in workflow that allows the AI to proofread the document.

3.0.0-alpha.18

Minor Changes

  • Server AI Toolkit tool definitions

3.0.0-alpha.17

Major Changes

  • Add tiptapEdit, tiptapRead, and tiptapReadSelection tools and set them as default. Remove readNodeRange, readSelection, insertContent and applyPatch tools.

3.0.0-alpha.16

Minor Changes

  • Add tiptapEdit, tiptapRead, and tiptapReadSelection tools that make edits faster and more efficient. These tools are experimental and opt-in.

3.0.0-alpha.15

Patch Changes

  • Fix bug that caused the AI to not read the document at the beginning of the chat interaction.

3.0.0-alpha.14

Patch Changes

  • Fix bug that caused the AI to read the entire document when it was not necessary to do so.

3.0.0-alpha.13

Patch Changes

  • Fix bug that caused the AI to read the incorrect content of the document after updating the document.

3.0.0-alpha.12

Patch Changes

  • Fix bug where new threads and comments were not created in the right position of the document.

3.0.0-alpha.11

Major Changes

  • New format for the tool input of the applyPatch tool. This format makes the tool definitions simpler and more consistent.
  • Improved tool output and tool definitions of all the built-in tools.
  • Requires upgrading to a version of the @tiptap-pro/ai-toolkit package that is equal or higher than 3.0.0-alpha.37

3.0.0-alpha.10

Major Changes

  • Makes the insertContent tool independent of the format of the content, by renaming the "html" property to "content".
  • Requires upgrading to a version of the @tiptap-pro/ai-toolkit package that is equal or higher than 3.0.0-alpha.36

Patch Changes

  • Fixes bug in insertContent tool where the activeNodeRange is not a valid value for the position.
  • Fixes bug where the insertContent tool would cause the activeNodeRange to always reset to 0.

3.0.0-alpha.9

Major Changes

  • Add new editThreads and getThreads tools for AI-powered comment and thread management
  • Requires upgrading to a version of the @tiptap-pro/ai-toolkit package that is equal or higher than 3.0.0-alpha.26

3.0.0-alpha.8

Major Changes

  • Rename applyDiff tool to applyPatch
  • Improve format and tool definition of the applyDiff tool (now called applyPatch) so that the AI generates a list of patch operations. This improves accuracy (because the AI is not tempted to do unnecessary jumps) and reduces token usage significantly

3.0.0-alpha.7

Minor Changes

  • Add activeNodeRange position to the insertContent tool to allow the AI to insert content at the active node range. This improves the accuracy of the edits when the applyDiff tool is disabled.

3.0.0-alpha.6

Minor Changes

  • Experimental implementation of the AI Toolkit + Pages extension integration. Introduces the readPage tool.

3.0.0-alpha.5

Major changes

  • Improve tool definitions of readSelection and insertContent tools to fix a bug where the AI inserts the content in the wrong place if the user changes the selection after the AI reads the selection. Requires a version of the AI Toolkit equal or higher than 3.0.0-alpha-17

3.0.0-alpha.4

Major Changes

  • Requires upgrading to a version of the @tiptap-pro/ai-toolkit package that is equal or higher than 3.0.0-alpha.14
  • Improved tool definitions for reading and editing the document

3.0.0-alpha.3

Minor Changes

  • Improve readFirstChunk tool description

3.0.0-alpha.2

Major Changes

  • Rename schema to inputSchema

3.0.0-alpha.1

Major Changes

  • Initial release with generic tool definitions for Tiptap AI Toolkit
PreviouslyAnthropic tools