@qverisai/mcp 0.8.0 → 0.10.0

package/README.md

@@ -1,385 +1,392 @@
-# @qverisai/mcp
-
-Official QVeris MCP Server — Dynamically search and execute tools via natural language.
-
-[![npm version](https://img.shields.io/npm/v/@qverisai/mcp.svg)](https://www.npmjs.com/package/@qverisai/mcp)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## Overview
-
-This SDK provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables LLMs to discover and execute third-party tools through the QVeris API. With a small set of tools, your AI assistant can:
-
-- **Discover** tools using natural language queries
-- **Inspect** detailed information about specific tools by their IDs
-- **Call** any discovered tool with the appropriate parameters
-- **Audit usage** with context-safe summaries or precise filtered records
-- **Review credits ledger** without dumping full account history into context
-
-## Quick Start
-
-### 1. Get Your API Key
-
-Visit [QVeris](https://qveris.ai) (Global) or [QVeris](https://qveris.cn) (China) to get your API key.
-
-### 2. Configure Your MCP Client
-
-Use the QVeris CLI to generate config without hand-editing JSON. Placeholder output intentionally fails API key validation until you replace it or use `--include-key`:
-
-```bash
-# Print safe config with YOUR_QVERIS_API_KEY placeholder
-qveris mcp configure --target cursor
-
-# Write a working config using your resolved API key
-qveris mcp configure --target cursor --write --include-key
-qveris mcp configure --target claude-desktop --write --include-key
-qveris mcp configure --target opencode --write --include-key
-qveris mcp configure --target openclaw --write --include-key
-
-# Validate config, or live-probe visible tools for stdio clients
-qveris mcp validate --target cursor
-qveris mcp validate --target cursor --probe
-```
-
-Add the QVeris server to your MCP client configuration:
-
-**Claude Desktop** (`claude_desktop_config.json`):
-
-```json
-{
-  "mcpServers": {
-    "qveris": {
-      "command": "npx",
-      "args": ["-y", "@qverisai/mcp"],
-      "env": {
-        "QVERIS_API_KEY": "your-api-key-here"
-      }
-    }
-  }
-}
-```
-
-**Cursor** (Settings → MCP Servers):
-
-```json
-{
-  "mcpServers": {
-    "qveris": {
-      "command": "npx",
-      "args": ["-y", "@qverisai/mcp"],
-      "env": {
-        "QVERIS_API_KEY": "your-api-key-here"
-      }
-    }
-  }
-}
-```
-
-### 3. Start Using
-
-Once configured, You could add this to system prompt:
-
-> "You can use qveris MCP Server to dynamically discover and call tools to help the user. First think about what kind of tools might be useful to accomplish the user's task. Then use the discover tool with a query describing the capability of the tool, not what params you want to pass to the tool later. Then call a suitable tool using the call tool, passing parameters through params_to_tool. You could reference the examples given if any for each tool. You may make multiple tool calls in a single response."
-
-Then your AI assistant can discover and call tools:
-
-> "Find me a weather tool and get the current weather in Tokyo"
-
-The assistant will:
-1. Call `discover` with query "weather"
-2. Optionally call `inspect` to review tool details
-3. Call `call` with the tool_id and parameters
-4. Use `usage_history` or `credits_ledger` only when the user asks about charge status or balance changes
-
-## Available Tools
-
-### `discover`
-
-Discover available tools based on natural language queries.
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `query` | string | ✓ | Natural language description of the capability you need |
-| `limit` | number | | Max results to return (1-100, default: 20) |
-| `session_id` | string | | Session identifier for tracking (auto-generated if omitted) |
-
-**Example:**
-
-```json
-{
-  "query": "send email notification",
-  "limit": 10
-}
-```
-
-### `inspect`
-
-Inspect tools by their IDs to get detailed information (parameters, success rate, latency, examples, and billing_rule when available).
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `tool_ids` | array | ✓ | Array of tool IDs to retrieve (at least one required) |
-| `search_id` | string | | Search ID from the discover call that returned the tool(s) |
-| `session_id` | string | | Session identifier (auto-generated if omitted) |
-
-**Example:**
-
-```json
-{
-  "tool_ids": ["openweathermap.weather.execute.v1", "worldbank_refined.search_indicators.v1"],
-  "search_id": "abcd1234-ab12-ab12-ab12-abcdef123456"
-}
-```
-
-### `call`
-
-Call a discovered tool with specific parameters.
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `tool_id` | string | ✓ | Tool ID from discover results |
-| `search_id` | string | ✓ | Search ID from the discover call that found this tool |
-| `params_to_tool` | object | ✓ | A dictionary of parameters to pass to the tool |
-| `session_id` | string | | Session identifier (auto-generated if omitted) |
-| `max_response_size` | number | | Max response size in bytes (default: 20480) |
-
-**Example:**
-
-```json
-{
-  "tool_id": "openweathermap.weather.execute.v1",
-  "search_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
-  "params_to_tool": {"city": "London", "units": "metric"}
-}
-```
-
-The `call` response may include compact pre-settlement `billing`. Final charge status should be checked with `usage_history` or `credits_ledger`.
-
-### `usage_history`
-
-Context-safe request-level usage audit. Defaults to aggregated `summary` mode.
-Summary mode requests service-side `summary=true` aggregates when available and falls back to bounded client-side aggregation for older deployments.
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `mode` | string | | `summary`, `search`, or `export_file` (default: `summary`) |
-| `start_date` | string | | Start date, `YYYY-MM-DD` |
-| `end_date` | string | | End date, `YYYY-MM-DD` |
-| `bucket` | string | | `hour`, `day`, or `week` for summary aggregation |
-| `execution_id` | string | | Precise execution lookup |
-| `search_id` | string | | Precise search lookup |
-| `charge_outcome` | string | | `charged`, `included`, `failed_not_charged`, `failed_charged_review` |
-| `min_credits` | number | | Lower credit amount bound |
-| `max_credits` | number | | Upper credit amount bound |
-| `limit` | number | | Search row cap, default 10, hard max 50 |
-
-Examples:
-
-```json
-{ "mode": "summary", "bucket": "hour" }
-```
-
-```json
-{ "mode": "search", "execution_id": "exec-123" }
-```
-
-```json
-{ "mode": "search", "min_credits": 30, "max_credits": 100 }
-```
-
-### `credits_ledger`
-
-Context-safe final credit ledger query. Defaults to aggregated `summary` mode.
-Summary mode requests service-side `summary=true` aggregates when available and falls back to bounded client-side aggregation for older deployments.
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `mode` | string | | `summary`, `search`, or `export_file` (default: `summary`) |
-| `start_date` | string | | Start date, `YYYY-MM-DD` |
-| `end_date` | string | | End date, `YYYY-MM-DD` |
-| `bucket` | string | | `hour`, `day`, or `week` for summary aggregation |
-| `entry_type` | string | | Ledger entry type, for example `consume_tool_execute` |
-| `direction` | string | | `consume`, `grant`, or `any` |
-| `min_credits` | number | | Lower absolute credit amount bound |
-| `max_credits` | number | | Upper absolute credit amount bound |
-| `limit` | number | | Search row cap, default 10, hard max 50 |
-
-Examples:
-
-```json
-{ "mode": "summary", "bucket": "day" }
-```
-
-```json
-{ "mode": "search", "direction": "consume", "min_credits": 50 }
-```
-
-Large result sets should use `mode: "export_file"`. The server writes JSONL under `.qveris/exports/` and returns the file path instead of emitting every row into MCP context.
-
-### Deprecated tool names
-
-For backward compatibility, the old tool names are still supported but emit a deprecation warning:
-
-| Old name (deprecated) | New name |
-|----------------------|----------|
-| `search_tools` | `discover` |
-| `get_tools_by_ids` | `inspect` |
-| `execute_tool` | `call` |
-
-## Session Management
-
-Providing a consistent `session_id` in a same user session in any tool call enables:
-- Consistent user tracking across multiple tool calls
-- Better analytics and usage patterns
-- Improved tool recommendations over time
-
-If not provided, the SDK automatically generates and maintains a session ID for the lifetime of the server process. However, this result in a much larger granularity of user sessions.
-
-## Response Handling
-
-### Successful Execution
-
-```json
-{
-  "execution_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
-  "tool_id": "openweathermap.weather.execute.v1",
-  "success": true,
-  "result": {
-    "data": {
-      "temperature": 15.5,
-      "humidity": 72,
-      "description": "partly cloudy"
-    }
-  },
-  "execution_time": 0.847
-}
-```
-
-### Large Responses
-
-When tool output exceeds `max_response_size`, you'll receive:
-
-```json
-{
-  "result": {
-    "message": "Result content is too long...",
-    "truncated_content": "[[1678233600000, \"22198.56...",
-    "full_content_file_url": "https://..."
-  }
-}
-```
-
-The `full_content_file_url` is valid for 120 minutes.
-
-## Transport modes
-
-The server speaks two MCP transports from the same binary:
-
-- **stdio** (default) — used by Claude Desktop, Cursor and other local clients. No change to existing configs.
-- **Streamable HTTP** — for remote deployment (e.g. Claude Desktop Custom Connectors, hosted/edge runtimes). Each client session gets its own session id (`Mcp-Session-Id` header), managed automatically.
-
-Enable HTTP mode with any of `--http`, `QVERIS_MCP_TRANSPORT=http`, or by setting an HTTP port/host:
-
-```bash
-# Local only (loopback): no inbound auth required
-QVERIS_API_KEY=sk-... npx -y @qverisai/mcp --http --port 3000
-
-# Exposed: bind all interfaces, require a bearer token, allow-list the public host
-QVERIS_API_KEY=sk-... \
-QVERIS_MCP_TRANSPORT=http \
-QVERIS_MCP_HTTP_HOST=0.0.0.0 \
-QVERIS_MCP_HTTP_AUTH_TOKEN=$(openssl rand -hex 32) \
-QVERIS_MCP_ALLOWED_HOSTS=mcp.example.com \
-npx -y @qverisai/mcp
-```
-
-- The endpoint is `POST/GET/DELETE {path}` (default `/mcp`); `GET /health` returns an unauthenticated liveness probe.
-- **Inbound auth:** set `QVERIS_MCP_HTTP_AUTH_TOKEN` to require `Authorization: Bearer <token>` on the MCP endpoint. The server **refuses to start** when binding a non-loopback host without a token, unless you set `QVERIS_MCP_HTTP_ALLOW_UNAUTHENTICATED=true` to delegate auth to an external proxy/gateway. Your `QVERIS_API_KEY` is the server's *outbound* credential to QVeris — it is **not** an inbound check, so anyone reaching an unauthenticated endpoint would spend your credits.
-- DNS-rebinding protection is **on by default** (localhost + the bound host/port are allow-listed). When exposing the server publicly, add your public host via `QVERIS_MCP_ALLOWED_HOSTS`.
-- Requests are capped at 4 MiB by default (`QVERIS_MCP_MAX_BODY_BYTES`), and idle sessions are evicted after 5 minutes (`QVERIS_MCP_SESSION_TIMEOUT_MS`).
-- **Discovery:** registries and crawlers can learn about the server without connecting:
-  - **Server Card** at `GET {path}/server-card` (default `/mcp/server-card`), media type `application/mcp-server-card+json` — server identity, version, and the remote endpoint.
-  - **MCP Catalog** at `GET /.well-known/mcp/catalog.json` — a site-wide index pointing at the Server Card.
-  - Both are public (unauthenticated, CORS-enabled), even when an auth token is set. Behind a TLS proxy, set `QVERIS_MCP_PUBLIC_URL` (or send `X-Forwarded-Proto`) so the advertised URLs use your public origin.
-- Full OAuth 2.1 authorization is tracked as a follow-up in [#107](https://github.com/QVerisAI/qveris-agent-toolkit/issues/107).
-
-## Environment Variables
-
-| Variable | Required | Description |
-|----------|----------|-------------|
-| `QVERIS_API_KEY` | ✓ | Your QVeris API key |
-| `QVERIS_REGION` | | Force region: `global` or `cn` (auto-detected from key prefix if not set) |
-| `QVERIS_BASE_URL` | | Override API base URL (highest priority, for custom endpoints) |
-| `QVERIS_MAX_RETRIES` | | Retries for rate-limited (429) / transient (503) responses (default 3; `0` disables). Honors `Retry-After`, else backs off with jitter. |
-| `QVERIS_MCP_TRANSPORT` | | `stdio` (default) or `http` |
-| `QVERIS_MCP_HTTP_PORT` | | HTTP port (default `3000`; setting it implies HTTP mode) |
-| `QVERIS_MCP_HTTP_HOST` | | HTTP bind host (default `127.0.0.1`) |
-| `QVERIS_MCP_HTTP_PATH` | | MCP endpoint path (default `/mcp`) |
-| `QVERIS_MCP_ALLOWED_HOSTS` | | Comma-separated extra `Host` values to allow (for DNS-rebinding protection) |
-| `QVERIS_MCP_ALLOWED_ORIGINS` | | Comma-separated extra `Origin` values to allow |
-| `QVERIS_MCP_DNS_REBINDING_PROTECTION` | | `true` (default) / `false` |
-| `QVERIS_MCP_HTTP_JSON` | | `true` to return JSON responses instead of SSE (default `false`) |
-| `QVERIS_MCP_HTTP_AUTH_TOKEN` | | Require `Authorization: Bearer <token>` on the MCP endpoint |
-| `QVERIS_MCP_HTTP_ALLOW_UNAUTHENTICATED` | | `true` to allow a non-loopback bind without a token (auth delegated externally) |
-| `QVERIS_MCP_MAX_BODY_BYTES` | | Max request body size in bytes (default `4194304`) |
-| `QVERIS_MCP_SESSION_TIMEOUT_MS` | | Idle session TTL in ms (default `300000`) |
-| `QVERIS_MCP_PUBLIC_URL` | | Public origin advertised in discovery documents (e.g. `https://mcp.example.com`) |
-
-## Region
-
-Region is auto-detected from your API key prefix — no extra configuration needed.
-
-| Key prefix | Region | API endpoint |
-|------------|--------|--------------|
-| `sk-xxx` | Global | `https://qveris.ai/api/v1` |
-| `sk-cn-xxx` | China | `https://qveris.cn/api/v1` |
-
-To override manually, set environment variables in your MCP client config:
-
-```json
-{
-  "mcpServers": {
-    "qveris": {
-      "command": "npx",
-      "args": ["-y", "@qverisai/mcp"],
-      "env": {
-        "QVERIS_API_KEY": "your-api-key",
-        "QVERIS_REGION": "cn"
-      }
-    }
-  }
-}
-```
-
-**Priority:** `QVERIS_BASE_URL` > `QVERIS_REGION` > API key prefix auto-detection > default (global)
-
-## Requirements
-
-- Node.js 18.0.0 or higher
-- A valid QVeris API key ([qveris.ai](https://qveris.ai) or [qveris.cn](https://qveris.cn))
-
-## Development
-
-```bash
-# Clone the repository
-git clone https://github.com/QVerisAI/qveris-agent-toolkit.git
-cd qveris-agent-toolkit/packages/mcp
-
-# Install dependencies
-npm install
-
-# Build
-npm run build
-
-# Run locally
-QVERIS_API_KEY=your-key node dist/index.js
-```
-
-## License
-
-MIT © [QVerisAI](https://github.com/QVerisAI)
-
-## Support
-
-- 🐛 [Issue Tracker](https://github.com/QVerisAI/qveris-agent-toolkit/issues)
-- 💬 Contact: contact@qveris.ai
-
+# @qverisai/mcp
+
+Official QVeris MCP Server — Dynamically search and execute tools via natural language.
+
+[![npm version](https://img.shields.io/npm/v/@qverisai/mcp.svg)](https://www.npmjs.com/package/@qverisai/mcp)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+This SDK provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables LLMs to discover and execute third-party tools through the QVeris API. With a small set of tools, your AI assistant can:
+
+- **Discover** tools using natural language queries
+- **Inspect** detailed information about specific tools by their IDs
+- **Call** any discovered tool with the appropriate parameters
+- **Audit usage** with context-safe summaries or precise filtered records
+- **Review credits ledger** without dumping full account history into context
+
+## Quick Start
+
+### 1. Get Your API Key
+
+Visit [QVeris](https://qveris.ai) to get your API key.
+
+### 2. Configure Your MCP Client
+
+Use the QVeris CLI to generate config without hand-editing JSON. Placeholder output intentionally fails API key validation until you replace it or use `--include-key`:
+
+```bash
+# Print safe config with YOUR_QVERIS_API_KEY placeholder
+qveris mcp configure --target cursor
+
+# Write a working config using your resolved API key
+qveris mcp configure --target cursor --write --include-key
+qveris mcp configure --target claude-desktop --write --include-key
+qveris mcp configure --target opencode --write --include-key
+qveris mcp configure --target openclaw --write --include-key
+
+# Validate config, or live-probe visible tools for stdio clients
+qveris mcp validate --target cursor
+qveris mcp validate --target cursor --probe
+```
+
+Add the QVeris server to your MCP client configuration:
+
+**Claude Desktop** (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "qveris": {
+      "command": "npx",
+      "args": ["-y", "@qverisai/mcp"],
+      "env": {
+        "QVERIS_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+**Cursor** (Settings → MCP Servers):
+
+```json
+{
+  "mcpServers": {
+    "qveris": {
+      "command": "npx",
+      "args": ["-y", "@qverisai/mcp"],
+      "env": {
+        "QVERIS_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+### 3. Start Using
+
+Once configured, You could add this to system prompt:
+
+> "You can use qveris MCP Server to dynamically discover and call tools to help the user. First think about what kind of tools might be useful to accomplish the user's task. Then use the discover tool with a query describing the capability of the tool, not what params you want to pass to the tool later. Then call a suitable tool using the call tool, passing parameters through params_to_tool. You could reference the examples given if any for each tool. You may make multiple tool calls in a single response."
+
+Then your AI assistant can discover and call tools:
+
+> "Find me a weather tool and get the current weather in Tokyo"
+
+The assistant will:
+1. Call `discover` with query "weather"
+2. Optionally call `inspect` to review tool details
+3. Call `call` with the tool_id and parameters
+4. Use `usage_history` or `credits_ledger` only when the user asks about charge status or balance changes
+
+## Available Tools
+
+### `discover`
+
+Discover available tools based on natural language queries.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `query` | string | ✓ | Natural language description of the capability you need |
+| `limit` | number | | Max results to return (1-100, default: 20) |
+| `session_id` | string | | Session identifier for tracking (auto-generated if omitted) |
+
+**Example:**
+
+```json
+{
+  "query": "send email notification",
+  "limit": 10
+}
+```
+
+### `inspect`
+
+Inspect tools by their IDs to get detailed information (parameters, success rate, latency, examples, and billing_rule when available).
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `tool_ids` | array | ✓ | Array of tool IDs to retrieve (at least one required) |
+| `search_id` | string | | Search ID from the discover call that returned the tool(s) |
+| `session_id` | string | | Session identifier (auto-generated if omitted) |
+
+**Example:**
+
+```json
+{
+  "tool_ids": ["openweathermap.weather.execute.v1", "worldbank_refined.search_indicators.v1"],
+  "search_id": "abcd1234-ab12-ab12-ab12-abcdef123456"
+}
+```
+
+### `call`
+
+Call a discovered tool with specific parameters.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `tool_id` | string | ✓ | Tool ID from discover results |
+| `search_id` | string | ✓ | Search ID from the discover call that found this tool |
+| `params_to_tool` | object | ✓ | A dictionary of parameters to pass to the tool |
+| `session_id` | string | | Session identifier (auto-generated if omitted) |
+| `max_response_size` | number | | Max response size in bytes (default: 20480) |
+
+**Example:**
+
+```json
+{
+  "tool_id": "openweathermap.weather.execute.v1",
+  "search_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
+  "params_to_tool": {"city": "London", "units": "metric"}
+}
+```
+
+The `call` response may include compact pre-settlement `billing`. Final charge status should be checked with `usage_history` or `credits_ledger`.
+
+### `usage_history`
+
+Context-safe request-level usage audit. Defaults to aggregated `summary` mode.
+Summary mode requests service-side `summary=true` aggregates when available and falls back to bounded client-side aggregation for older deployments.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `mode` | string | | `summary`, `search`, or `export_file` (default: `summary`) |
+| `start_date` | string | | Start date, `YYYY-MM-DD` |
+| `end_date` | string | | End date, `YYYY-MM-DD` |
+| `bucket` | string | | `hour`, `day`, or `week` for summary aggregation |
+| `execution_id` | string | | Precise execution lookup |
+| `search_id` | string | | Precise search lookup |
+| `charge_outcome` | string | | `charged`, `included`, `failed_not_charged`, `failed_charged_review` |
+| `min_credits` | number | | Lower credit amount bound |
+| `max_credits` | number | | Upper credit amount bound |
+| `limit` | number | | Search row cap, default 10, hard max 50 |
+
+Examples:
+
+```json
+{ "mode": "summary", "bucket": "hour" }
+```
+
+```json
+{ "mode": "search", "execution_id": "exec-123" }
+```
+
+```json
+{ "mode": "search", "min_credits": 30, "max_credits": 100 }
+```
+
+### `credits_ledger`
+
+Context-safe final credit ledger query. Defaults to aggregated `summary` mode.
+Summary mode requests service-side `summary=true` aggregates when available and falls back to bounded client-side aggregation for older deployments.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `mode` | string | | `summary`, `search`, or `export_file` (default: `summary`) |
+| `start_date` | string | | Start date, `YYYY-MM-DD` |
+| `end_date` | string | | End date, `YYYY-MM-DD` |
+| `bucket` | string | | `hour`, `day`, or `week` for summary aggregation |
+| `entry_type` | string | | Ledger entry type, for example `consume_tool_execute` |
+| `direction` | string | | `consume`, `grant`, or `any` |
+| `min_credits` | number | | Lower absolute credit amount bound |
+| `max_credits` | number | | Upper absolute credit amount bound |
+| `limit` | number | | Search row cap, default 10, hard max 50 |
+
+Examples:
+
+```json
+{ "mode": "summary", "bucket": "day" }
+```
+
+```json
+{ "mode": "search", "direction": "consume", "min_credits": 50 }
+```
+
+Large result sets should use `mode: "export_file"`. The server writes JSONL under `.qveris/exports/` and returns the file path instead of emitting every row into MCP context.
+
+### Deprecated tool names
+
+For backward compatibility, the old tool names are still supported but emit a deprecation warning:
+
+| Old name (deprecated) | New name |
+|----------------------|----------|
+| `search_tools` | `discover` |
+| `get_tools_by_ids` | `inspect` |
+| `execute_tool` | `call` |
+
+## Beyond tools: schemas, consent, resources
+
+- Every tool declares an `outputSchema` and returns `structuredContent` alongside the JSON text (MCP 2025-06-18), so clients get typed results.
+- With `QVERIS_MCP_CONFIRM_CALLS=true`, a charged `call` first asks the user to confirm via MCP **elicitation** (billing consent); declining cancels the call before any credits are spent. Off by default.
+- **Resources**: read `qveris://server-card` for the server's identity card, or `qveris://capability/{tool_id}` for a capability's full metadata (parameters, examples, stats, billing) without spending a tool call.
+
+## Session Management
+
+Providing a consistent `session_id` in a same user session in any tool call enables:
+- Consistent user tracking across multiple tool calls
+- Better analytics and usage patterns
+- Improved tool recommendations over time
+
+If not provided, the SDK automatically generates and maintains a session ID for the lifetime of the server process. However, this result in a much larger granularity of user sessions.
+
+## Response Handling
+
+### Successful Execution
+
+```json
+{
+  "execution_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
+  "tool_id": "openweathermap.weather.execute.v1",
+  "success": true,
+  "result": {
+    "data": {
+      "temperature": 15.5,
+      "humidity": 72,
+      "description": "partly cloudy"
+    }
+  },
+  "execution_time": 0.847
+}
+```
+
+### Large Responses
+
+When tool output exceeds `max_response_size`, you'll receive:
+
+```json
+{
+  "result": {
+    "message": "Result content is too long...",
+    "truncated_content": "[[1678233600000, \"22198.56...",
+    "full_content_file_url": "https://..."
+  }
+}
+```
+
+The `full_content_file_url` is valid for 120 minutes.
+
+## Transport modes
+
+The server speaks two MCP transports from the same binary:
+
+- **stdio** (default) — used by Claude Desktop, Cursor and other local clients. No change to existing configs.
+- **Streamable HTTP** — for remote deployment (e.g. Claude Desktop Custom Connectors, hosted/edge runtimes). Each client session gets its own session id (`Mcp-Session-Id` header), managed automatically.
+
+Enable HTTP mode with any of `--http`, `QVERIS_MCP_TRANSPORT=http`, or by setting an HTTP port/host:
+
+```bash
+# Local only (loopback): no inbound auth required
+QVERIS_API_KEY=sk-... npx -y @qverisai/mcp --http --port 3000
+
+# Exposed: bind all interfaces, require a bearer token, allow-list the public host
+QVERIS_API_KEY=sk-... \
+QVERIS_MCP_TRANSPORT=http \
+QVERIS_MCP_HTTP_HOST=0.0.0.0 \
+QVERIS_MCP_HTTP_AUTH_TOKEN=$(openssl rand -hex 32) \
+QVERIS_MCP_ALLOWED_HOSTS=mcp.example.com \
+npx -y @qverisai/mcp
+```
+
+- The endpoint is `POST/GET/DELETE {path}` (default `/mcp`); `GET /health` returns an unauthenticated liveness probe.
+- **Inbound auth:** set `QVERIS_MCP_HTTP_AUTH_TOKEN` to require `Authorization: Bearer <token>` on the MCP endpoint. The server **refuses to start** when binding a non-loopback host without a token, unless you set `QVERIS_MCP_HTTP_ALLOW_UNAUTHENTICATED=true` to delegate auth to an external proxy/gateway. Your `QVERIS_API_KEY` is the server's *outbound* credential to QVeris — it is **not** an inbound check, so anyone reaching an unauthenticated endpoint would spend your credits.
+- **Embedding API:** the package root exports `startHttpServer`, `resolveTransportConfig`, `QverisClient`, and the session-auth types. An independently operated service can set `requireSessionBearer` on its resolved transport config and provide an asynchronous session factory. The transport requires a bearer, passes it only to that factory, stores only a credential fingerprint for session binding, and rejects credential changes. The embedding service owns validation, client construction, rate limits, deployment, and operations.
+- DNS-rebinding protection is **on by default** (localhost + the bound host/port are allow-listed). When exposing the server publicly, add your public host via `QVERIS_MCP_ALLOWED_HOSTS`.
+- Requests are capped at 4 MiB by default (`QVERIS_MCP_MAX_BODY_BYTES`), and idle sessions are evicted after 5 minutes (`QVERIS_MCP_SESSION_TIMEOUT_MS`).
+- **Discovery:** registries and crawlers can learn about the server without connecting:
+  - **Server Card** at `GET {path}/server-card` (default `/mcp/server-card`), media type `application/mcp-server-card+json` — server identity, version, and the remote endpoint.
+  - **MCP Catalog** at `GET /.well-known/mcp/catalog.json` — a site-wide index pointing at the Server Card.
+  - Both are public (unauthenticated, CORS-enabled), even when an auth token is set. Behind a TLS proxy, set `QVERIS_MCP_PUBLIC_URL` (or send `X-Forwarded-Proto`) so the advertised URLs use your public origin.
+- Full OAuth 2.1 authorization is tracked as a follow-up in [#107](https://github.com/QVerisAI/qveris-agent-toolkit/issues/107).
+
+## Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `QVERIS_API_KEY` | ✓ | Your QVeris API key |
+| `QVERIS_BASE_URL` | | Override the built-in API base URL |
+| `QVERIS_MAX_RETRIES` | | Retries for rate-limited (429) / transient (503) responses (default 3; `0` disables). Honors `Retry-After`, else backs off with jitter. |
+| `QVERIS_MCP_TRANSPORT` | | `stdio` (default) or `http` |
+| `QVERIS_MCP_HTTP_PORT` | | HTTP port (default `3000`; setting it implies HTTP mode) |
+| `QVERIS_MCP_HTTP_HOST` | | HTTP bind host (default `127.0.0.1`) |
+| `QVERIS_MCP_HTTP_PATH` | | MCP endpoint path (default `/mcp`) |
+| `QVERIS_MCP_ALLOWED_HOSTS` | | Comma-separated extra `Host` values to allow (for DNS-rebinding protection) |
+| `QVERIS_MCP_ALLOWED_ORIGINS` | | Comma-separated extra `Origin` values to allow |
+| `QVERIS_MCP_DNS_REBINDING_PROTECTION` | | `true` (default) / `false` |
+| `QVERIS_MCP_HTTP_JSON` | | `true` to return JSON responses instead of SSE (default `false`) |
+| `QVERIS_MCP_HTTP_AUTH_TOKEN` | | Require `Authorization: Bearer <token>` on the MCP endpoint |
+| `QVERIS_MCP_HTTP_ALLOW_UNAUTHENTICATED` | | `true` to allow a non-loopback bind without a token (auth delegated externally) |
+| `QVERIS_MCP_MAX_BODY_BYTES` | | Max request body size in bytes (default `4194304`) |
+| `QVERIS_MCP_SESSION_TIMEOUT_MS` | | Idle session TTL in ms (default `300000`) |
+| `QVERIS_MCP_CONFIRM_CALLS` | | `true` to ask the user (via MCP elicitation) before each charged `call`; clients without elicitation proceed as before |
+| `QVERIS_MCP_PUBLIC_URL` | | Public origin advertised in discovery documents (e.g. `https://mcp.example.com`) |
+
+## API Endpoint Override
+
+The server uses its built-in API endpoint unless `QVERIS_BASE_URL` is set. API key prefixes and other environment variables do not select an endpoint. To target a custom endpoint, set `QVERIS_BASE_URL` in your MCP client config:
+
+```json
+{
+  "mcpServers": {
+    "qveris": {
+      "command": "npx",
+      "args": ["-y", "@qverisai/mcp"],
+      "env": {
+        "QVERIS_API_KEY": "your-api-key",
+        "QVERIS_BASE_URL": "https://qveris.ai/api/v1"
+      }
+    }
+  }
+}
+```
+
+The override must be an HTTP(S) URL without credentials, a query string, or a fragment.
+
+## Examples
+
+[`examples/agent-loop.ts`](examples/agent-loop.ts) drives this server over stdio
+the way an agent runtime does: spawn it, list the tools, then run
+discover → inspect → call by calling those tools. It is safe to run without an
+API key (tool listing works unconfigured), and the call step is gated behind
+`RUN_QVERIS_CALLS=1`.
+
+## Requirements
+
+- Node.js 18.0.0 or higher
+- A valid QVeris API key ([qveris.ai](https://qveris.ai))
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/QVerisAI/qveris-agent-toolkit.git
+cd qveris-agent-toolkit/packages/mcp
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run locally
+QVERIS_API_KEY=your-key node dist/index.js
+```
+
+## License
+
+MIT © [QVerisAI](https://github.com/QVerisAI)
+
+## Support
+
+- 🐛 [Issue Tracker](https://github.com/QVerisAI/qveris-agent-toolkit/issues)
+- 💬 Contact: contact@qveris.ai