This is an automated email from the ASF dual-hosted git repository.
cgivre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/drill-mcp.git
The following commit(s) were added to refs/heads/main by this push:
new f3de8d8 Document stdio-only deployment model in README
f3de8d8 is described below
commit f3de8d8cb99f429701219bc82f34af9603a5fbd6
Author: cgivre <[email protected]>
AuthorDate: Sun Oct 11 10:24:48 2026 -0400
Document stdio-only deployment model in README
---
README.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md
index 70d0053..e2f8fed 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,30 @@ Full parameters, return shapes, errors, and per-tool
surprises are in
single call but never raise it above the configured limit. A truncated
result is marked `"truncated": true`.
+## Deployment
+
+`drill-mcp` speaks MCP over stdio only. Each MCP client launches its own
+server process, and that process serves exactly one client. It is built
+for local, single-user use.
+
+- **Every tool call runs as the Drill identity in the config.** The server
+ has no notion of who is calling; whoever can talk to the process gets
+ that user's Drill access.
+- **Policy is per process.** `writable_plugins`, `hidden_schemas`, and
+ `max_rows` apply to every call the process handles.
+- **`cancel_query` accepts any query id** the configured Drill user is
+ permitted to cancel.
+
+To give several people access, run one process per user with that user's
+own credentials. Do not put a network proxy in front of the stdio process:
+that would share one Drill identity, one policy, and unrestricted
+`cancel_query` with everyone who can reach the proxy.
+
+An HTTP transport is a possible future enhancement. Shipping one safely
+needs client authentication, a Drill identity (or impersonation) per
+caller, authorization for `cancel_query`, and confirmation that the JDBC
+backend tolerates concurrent calls.
+
## Backends
- **REST** (default, `backend: rest`): talks to a Drillbit's HTTP endpoints
