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

DroidMcp

The SDK entry point. Built via DroidMcp.builder / Builder, it owns a ToolRegistry and both transports: an always-on InProcessTransport for on-device LLMs (listTools / callTool) and an optional HttpTransport for desktop MCP clients (startServer).

Also surfaces the 1.0 hardening controls: runtime per-tool gating (setToolEnabled / setDisabledTools), token rotation (rotateToken), per-client pairing (pairClient / revokeClient / pairedClients), and the TLS fingerprint (tlsFingerprint) to pin in a pairing QR.

Types

Builder

class Builder

Fluent builder for DroidMcp. Add tools, optionally enable the HTTP server, TLS, and an audit sink, then call build. All setters return this for chaining.

Companion

object Companion

Properties

serverToken

val serverToken: String?

The HTTP server's effective bearer token, or null if the server is disabled or open (no auth).

tlsFingerprint

val tlsFingerprint: String?

SHA-256 fingerprint of the server's TLS certificate to pin in the pairing QR, or null if the server is plaintext. See TlsConfig.certFingerprintSha256.

Functions

callTool

suspend fun callTool(name: String, params: Map<String, Any>): ToolResult

Invoke a tool directly in-process, bypassing JSON-RPC. Honours runtime gating.

suspend fun callTool(name: String, params: Map<String, Any>, onProgress: suspend (ProgressUpdate) -> Unit): ToolResult

Like callTool, delivering the tool's reportProgress updates to onProgress.

disabledTools

fun disabledTools(): Set<String>

Names currently gated off.

getPrompt

suspend fun getPrompt(name: String, arguments: Map<String, String> = emptyMap()): PromptResult?

Render a prompt in-process; see InProcessTransport.getPrompt.

isServerRunning

fun isServerRunning(): Boolean

Whether the HTTP server is currently running.

listPrompts

fun listPrompts(): List<McpPrompt>

Prompts whose required tools are all enabled (in-process).

listResources

suspend fun listResources(): List<McpResource>

Every provider's advertised resources (in-process).

listResourceTemplates

fun listResourceTemplates(): List<McpResourceTemplate>

Every provider's URI templates (in-process).

listTools

fun listTools(): List<McpTool>

The enabled tools as live McpTool instances (in-process); gated-off tools are excluded.

listToolsJson

fun listToolsJson(): String

The registered tools serialised to a JSON catalogue; see InProcessTransport.listToolsJson.

pairClient

fun pairClient(label: String): String?

Mint a revocable token for a named client. Re-pairing an existing label replaces its token. Returns the new token, or null when there's no authenticated HTTP server.

pairedClients

fun pairedClients(): List<TokenStore.PairedClient>

Snapshot of paired clients (excludes the primary).

readResource

suspend fun readResource(uri: String): List<ResourceContents>?

The contents at uri, or null when nothing handles it (in-process).

registerResourceProvider

fun registerResourceProvider(provider: ResourceProvider)

Add a resource provider at runtime; connected clients get notifications/resources/list_changed.

registerTools

fun registerTools(toolList: List<McpTool>)

Register more tools after Builder.build — e.g. once the user grants the permission they need. Connected HTTP clients get notifications/tools/list_changed.

revokeClient

fun revokeClient(label: String): Boolean

Revoke a paired client's token. @return true if a client with that label existed.

rotateToken

fun rotateToken(): String?

Rotate the primary bearer token, invalidating the old one (paired clients keep theirs). Returns the new token, or null if the HTTP server is disabled or running without auth. Re-issue the pairing QR after calling.

setDisabledTools

fun setDisabledTools(names: Set<String>)

Replace the full set of gated-off tools in one call.

setToolEnabled

fun setToolEnabled(name: String, enabled: Boolean)

Gate a single tool on or off at runtime. A disabled tool disappears from tools/list and is rejected by tools/call (both transports) without being unregistered, so the host can drive a per-tool checkbox grid without rebuilding the server. No-op for unknown names.

startServer

fun startServer()

Start the HTTP server. Throws if the server was not enabled via Builder.enableHttpServer.

stopServer

fun stopServer()

Stop the HTTP server if running; no-op when the server is disabled.

unregisterResourceProvider

fun unregisterResourceProvider(provider: ResourceProvider)

Remove a resource provider added with Builder.addResourceProvider or registerResourceProvider.

unregisterTool

fun unregisterTool(name: String): Boolean

Remove a tool at runtime (e.g. after its permission is revoked). @return true if it was registered.