Tiptap Docs

Anthropic - AI agent tools

The @tiptap-pro/ai-toolkit-anthropic package provides tool definitions you can add to your AI agent built with Anthropic's JavaScript SDK.

The tool calls generated by the model can then be executed in the client-side using the executeTool method.

Example usage

Install the package.

npm install @tiptap-pro/ai-toolkit-anthropic

Supply the tool definitions to your Anthropic model.

import Anthropic from '@anthropic-ai/sdk'
import { toolDefinitions } from '@tiptap-pro/ai-toolkit-anthropic'

const anthropic = new Anthropic()

const response = await anthropic.messages.create({
  model: 'claude-sonnet-4-5',
  max_tokens: 2048,
  system: 'You are a helpful assistant that can edit rich text documents.',
  messages: [{ role: 'user', content: 'Help me edit this document' }],
  tools: toolDefinitions(),
})

Combine the tool definitions with your custom tools.

import Anthropic from '@anthropic-ai/sdk'
import { toolDefinitions } from '@tiptap-pro/ai-toolkit-anthropic'

const anthropic = new Anthropic()

const customTools = [
  {
    name: 'get_weather',
    description: 'Get the weather in a location',
    input_schema: {
      type: 'object',
      properties: {
        location: {
          type: 'string',
          description: 'The city and state, e.g. San Francisco, CA',
        },
      },
      required: ['location'],
    },
  },
]

const response = await anthropic.messages.create({
  model: 'claude-sonnet-4-5',
  max_tokens: 1024,
  messages: [{ role: 'user', content: 'What is the weather like and help me edit this document' }],
  tools: [...toolDefinitions(), ...customTools],
})

API reference

toolDefinitions

Creates tool definitions for the Tiptap AI Toolkit compatible with Anthropic's Messages API.

Parameters (ToolDefinitionsOptions)

  • tools?: EnabledTools - Enable/disable specific tools by setting the value to true (enabled) or false (disabled).
    • tiptapRead?: boolean - Enable/disable the tiptapRead tool (default: true)
    • tiptapEdit?: boolean - Enable/disable the tiptapEdit tool (default: true)
    • tiptapReadSelection?: boolean - Enable/disable the tiptapReadSelection tool (default: true)
    • getThreads?: boolean - Enable/disable the getThreads tool (default: false)
    • editThreads?: boolean - Enable/disable the editThreads tool (default: false)

Returns

An array containing the enabled tool definitions that can be used with Anthropic's Messages API. To see the full list of tools, see the Available tools page.

PreviouslyOpenAI