mcp-use TypeScript API
    Preparing search index...

    Interface CommonAgentOptions

    Options shared by explicit and simplified LangChain agents.

    interface CommonAgentOptions {
        adapter?: LangChainAdapter;
        additionalInstructions?: string | null;
        additionalTools?: StructuredToolInterface<ToolInputSchemaBase, any, any>[];
        agentId?: string;
        apiKey?: string;
        autoInitialize?: boolean;
        baseUrl?: string;
        callbacks?: BaseCallbackHandler[];
        disallowedTools?: string[];
        exposePromptsAsTools?: boolean;
        exposeResourcesAsTools?: boolean;
        maxSteps?: number;
        memoryEnabled?: boolean;
        observe?: boolean;
        serverManagerFactory?: (client: MCPClient) => ServerManager;
        systemPrompt?: string | null;
        systemPromptTemplate?: string | null;
        toolsUsedNames?: string[];
        useServerManager?: boolean;
        verbose?: boolean;
    }

    Hierarchy (View Summary)

    Index
    adapter? additionalInstructions? additionalTools? agentId? apiKey? autoInitialize? baseUrl? callbacks? disallowedTools? exposePromptsAsTools? exposeResourcesAsTools? maxSteps? memoryEnabled? observe? serverManagerFactory? systemPrompt? systemPromptTemplate? toolsUsedNames? useServerManager? verbose?
    adapter?: LangChainAdapter

    Adapter used to create LangChain tools.

    additionalInstructions?: string | null

    Instructions appended to the generated system message.

    additionalTools?: StructuredToolInterface<ToolInputSchemaBase, any, any>[]

    Additional LangChain tools exposed alongside MCP tools.

    agentId?: string

    Hosted agent identifier for remote execution.

    apiKey?: string

    Remote API key. Defaults to MCP_USE_API_KEY.

    autoInitialize?: boolean

    Initializes the agent on its first run. Defaults to false.

    baseUrl?: string

    Remote API origin.

    callbacks?: BaseCallbackHandler[]

    Custom LangChain observability callbacks.

    disallowedTools?: string[]

    MCP tool names to omit from the agent.

    exposePromptsAsTools?: boolean

    Exposes MCP prompts as tools. Defaults to true.

    exposeResourcesAsTools?: boolean

    Exposes MCP resources as tools. Defaults to true.

    maxSteps?: number

    Maximum model calls per run. Defaults to 5.

    memoryEnabled?: boolean

    Retains conversation history between runs. Defaults to true.

    observe?: boolean

    Enables observability callbacks. Defaults to true.

    serverManagerFactory?: (client: MCPClient) => ServerManager

    Factory used to customize server management.

    systemPrompt?: string | null

    Complete system instruction override.

    systemPromptTemplate?: string | null

    Template used to build the system instruction from available tools.

    toolsUsedNames?: string[]

    Mutable array populated with tool names used during execution.

    useServerManager?: boolean

    Enables dynamic server-selection tools.

    verbose?: boolean

    Enables detailed execution logging.

    Settings
    Member Visibility

    On This Page
    Properties