LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangChain
  • Browser
  • Universal
  • Hub
  • Node
  • Load
  • Serializable
  • Encoder Backed
  • File System
  • In Memory
  • Tools
LangChain Core
  • Agents
  • Caches
  • Base
  • Dispatch
  • Web
  • Manager
  • Promises
  • Chat History
  • Context
  • Base
  • Langsmith
  • Documents
  • Embeddings
  • Errors
  • Example Selectors
  • Indexing
  • Base
  • Chat Models
  • Compat
  • Event
  • Llms
  • Openai Completions Stream
  • Profile
  • Stream
  • Structured Output
  • Load
  • Serializable
  • Memory
  • Messages
  • Tool
  • Output Parsers
  • Openai Functions
  • Openai Tools
  • Outputs
  • Prompt Values
  • Prompts
  • Retrievers
  • Document Compressors
  • Runnables
  • Graph
  • Singletons
  • Stores
  • Structured Query
  • Testing
  • Tools
  • Base
  • Console
  • Log Stream
  • Run Collector
  • Tracer Langchain
  • Stream
  • Async Caller
  • Chunk Array
  • Context
  • Env
  • Event Source Parse
  • Format
  • Function Calling
  • Gateway
  • Hash
  • Json Patch
  • Json Schema
  • Math
  • Ssrf
  • Standard Schema
  • Stream
  • Testing
  • Tiktoken
  • Types
  • Uuid
  • Vectorstores
Text Splitters
MCP Adapters
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangChain
BrowserUniversalHubNodeLoadSerializableEncoder BackedFile SystemIn MemoryTools
LangChain Core
AgentsCachesBaseDispatchWebManagerPromisesChat HistoryContextBaseLangsmithDocumentsEmbeddingsErrorsExample SelectorsIndexingBaseChat ModelsCompatEventLlmsOpenai Completions StreamProfileStreamStructured OutputLoadSerializableMemoryMessagesToolOutput ParsersOpenai FunctionsOpenai ToolsOutputsPrompt ValuesPromptsRetrieversDocument CompressorsRunnablesGraphSingletonsStoresStructured QueryTestingToolsBaseConsoleLog StreamRun CollectorTracer LangchainStreamAsync CallerChunk ArrayContextEnvEvent Source ParseFormatFunction CallingGatewayHashJson PatchJson SchemaMathSsrfStandard SchemaStreamTestingTiktokenTypesUuidVectorstores
Text Splitters
MCP Adapters
Language
Theme
JavaScript@langchain/coretoolsToolWrapperParams
Interface●Since v1.1

ToolWrapperParams

Parameters for the tool function. Schema can be provided as Zod or JSON schema. Both schema types will be validated.

Copy
interface ToolWrapperParams

Bases

ToolParams

Properties

property
callbacks: Callbacks
property
defaultConfig: ToolRunnableConfig<Record<string, any>, any>

Default config object for the tool runnable.

property
description: string

The description of the tool.

property
extras: Record<string, unknown>

Optional provider-specific extra fields for the tool.

This is used to pass provider-specific configuration that doesn't fit into standard tool fields.

property
metadata: Record<string, unknown>

Metadata for the tool.

property
name: NameT

The name of the tool. If using with an LLM, this will be passed as the tool name.

property
responseFormat: string

The tool response format.

If "content" then the output of the tool is interpreted as the contents of a ToolMessage. If "content_and_artifact" then the output is expected to be a two-tuple corresponding to the (content, artifact) of a ToolMessage.

property
returnDirect: boolean

Whether to return the tool's output directly.

Setting this to true means that after the tool is called, an agent should stop looping.

property
schema: RunInput

The input schema for the tool. If using an LLM, this will be passed as the tool schema to generate arguments for.

property
tags: string[]
property
verbose: boolean
property
verboseParsingErrors: boolean

Whether to show full details in the thrown parsing errors.

Inherited fromToolParams

Properties

Pcallbacks: CallbacksPdefaultConfig: ToolRunnableConfig<Record<string, any>, any>
—

Default config object for the tool runnable.

Pextras: Record<string, unknown>
—

Optional provider-specific extra fields for the tool.

Pmetadata: Record<string, unknown>
—

Metadata for the tool.

PresponseFormat: string
—

The tool response format.

Ptags: string[]Pverbose: booleanPverboseParsingErrors: boolean
—

Whether to show full details in the thrown parsing errors.

Inherited fromBaseLangChainParams

Properties

Pcallbacks: CallbacksPmetadata: Record<string, unknown>Ptags: string[]Pverbose: boolean
View source on GitHub