droid-mcp-core/io.droidmcp.core/ToolRegistry

ToolRegistry

class ToolRegistry(val toolTimeoutMs: Long = DEFAULT_TOOL_TIMEOUT_MS, confirmer: ToolCallConfirmer? = null, requiresConfirmation: (McpTool) -> Boolean = { it.annotations.destructiveHint })

Thread-safe collection of registered McpTools, keyed by McpTool.name. Backed by a ConcurrentHashMap so tools can be registered and invoked concurrently. Also tracks a host-controlled runtime gate (see setDisabledTools) that hides/blocks tools without unregistering them.

This is the single source of truth the transports and McpProtocol read from for tools/list and tools/call. Every change to the client-visible set (register, unregister, gate edits) is reported to addChangeListener subscribers; the HTTP transport turns that into notifications/tools/list_changed.

Constructors

ToolRegistry

constructor(toolTimeoutMs: Long = DEFAULT_TOOL_TIMEOUT_MS, confirmer: ToolCallConfirmer? = null, requiresConfirmation: (McpTool) -> Boolean = { it.annotations.destructiveHint })

Types

Companion

object Companion

Properties

toolTimeoutMs

val toolTimeoutMs: Long

Upper bound on a single executeTool call; a tool still running after this is cancelled and reported as a tool_timeout error. Must be positive. The same bound applies to waiting for confirmer.

Functions

addChangeListener

fun addChangeListener(listener: () -> Unit)

Call listener whenever the client-visible tool set may have changed.

disabledTools

fun disabledTools(): Set<String>

Names currently gated off.

executeTool

suspend fun executeTool(name: String, params: Map<String, Any>, clientLabel: String? = null): ToolResult

Execute the named tool with params on Dispatchers.IO, bounded by toolTimeoutMs. Returns a tool_disabled error if the tool is gated off, an Unknown tool error if it isn't registered, a tool_timeout error if it overran, and converts any exception thrown by McpTool.execute into a failed ToolResult. Coroutine cancellation of the caller is rethrown rather than swallowed, so a cancelled request stops its tool.

getTool

fun getTool(name: String): McpTool?

The registered tool with this name, or null if none is registered.

isEnabled

fun isEnabled(name: String): Boolean

Whether the named tool is currently enabled (registered tools are enabled by default).

listEnabledTools

fun listEnabledTools(): List<McpTool>

Tools currently visible to clients — registered and not gated off.

listTools

fun listTools(): List<McpTool>

All registered tools, regardless of gate state. See listEnabledTools for the client-visible set.

fun register(tool: McpTool)

registerAll

fun registerAll(toolList: List<McpTool>)

removeChangeListener

fun removeChangeListener(listener: () -> Unit)

setDisabledTools

@Synchronized

fun setDisabledTools(names: Set<String>)

Replace the entire disabled set in one atomic swap (e.g. from a checkbox grid). @Synchronized on the same monitor as setToolEnabled so a full replace can't interleave with a single-tool toggle and lose its update.

setToolEnabled

@Synchronized

fun setToolEnabled(name: String, enabled: Boolean)

Enable or disable a single tool by name. @Synchronized so concurrent single-tool toggles don't lose updates in the copy-on-write swap.

unregister

fun unregister(name: String): Boolean

Remove the named tool (e.g. after the user revokes the permission it needs).