Skip to content

Commit 757eae1

Browse files
linfangwlinfangw
authored
docs: align hosted MCP endpoint guidance (#234)
1 parent 5ec5ff0 commit 757eae1

3 files changed

Lines changed: 99 additions & 18 deletions

File tree

‎docs/cn/zh-CN/mcp-server.md‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,37 @@ qveris mcp validate --target cursor --probe
122122

123123
## Hosted MCP
124124

125-
Hosted MCP 已列入规划，但当前接入路径不依赖托管端点。在正式发布托管端点前，请使用上文的 stdio server：`npx -y @qverisai/mcp`。
125+
QVeris 提供远程 Streamable HTTP MCP 托管服务，无需安装本地软件包或运行后台进程。如果端点暂时不可用，请在托管服务发布完成前继续使用上文的本地 stdio 软件包。
126126

127-
托管 MCP 端点可用后，接入流程会是：
127+
```text
128+
https://mcp.qveris.cn/mcp
129+
```
130+
131+
在支持远程 MCP 的客户端中添加服务地址，并在每次请求中发送 QVeris API 密钥：
132+
133+
```json
134+
{
135+
"mcpServers": {
136+
"qveris": {
137+
"type": "http",
138+
"url": "https://mcp.qveris.cn/mcp",
139+
"headers": {
140+
"Authorization": "Bearer YOUR_QVERIS_API_KEY"
141+
}
142+
}
143+
}
144+
}
145+
```
146+
147+
接入步骤：
148+
149+
1. 在[控制台/API 密钥](/account?page=api-keys)创建密钥。
150+
2. 将服务地址和 Bearer 请求头添加到客户端。客户端支持时，请用密钥管理或环境变量保存 API 密钥，切勿提交到源代码仓库。
151+
3. 重新连接客户端，确认 `discover`、`inspect`、`call` 可见。
152+
153+
服务会在会话启动时验证并绑定密钥。`401` 表示密钥缺失或无效；`503` 表示验证服务暂时不可用。更换密钥后请新建 MCP 会话。可前往[托管 MCP 页面](/hosted-mcp)复制配置。
128154

129-
1. 创建或选择一个 QVeris API key。
130-
2. 从 QVeris 控制台或文档复制 hosted MCP URL。
131-
3. 按 MCP 客户端的远程 MCP 配置流程添加该 hosted URL。
132-
4. 运行 `qveris mcp validate --target <client>` 或使用客户端内置工具列表，确认 `discover`、`inspect`、`call` 可见。
155+
不支持远程 Streamable HTTP MCP 的客户端仍可使用本地 stdio 软件包。
133156

134157
---
135158

‎docs/en-US/mcp-server.md‎

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,43 @@ For environment-specific setup guides, see:
141141

142142
## Hosted MCP
143143

144-
Hosted MCP is planned but not required for the current onboarding path. Until a hosted endpoint is published, use the stdio server shown above with `npx -y @qverisai/mcp`.
144+
QVeris provides a remote Streamable HTTP MCP service. It requires no local package or background process. If the endpoint is not yet available, continue using the local stdio package shown above while the hosted service rollout completes.
145145

146-
When a hosted MCP endpoint becomes available, the onboarding flow will be:
146+
```text
147+
https://mcp.qveris.ai/mcp
148+
```
149+
150+
Add the endpoint to a remote-MCP-compatible client and send your QVeris API key on every request:
151+
152+
```json
153+
{
154+
"mcpServers": {
155+
"qveris": {
156+
"type": "http",
157+
"url": "https://mcp.qveris.ai/mcp",
158+
"headers": {
159+
"Authorization": "Bearer YOUR_QVERIS_API_KEY"
160+
}
161+
}
162+
}
163+
}
164+
```
165+
166+
Claude Code can add it from the command line:
167+
168+
```bash
169+
claude mcp add --transport http qveris https://mcp.qveris.ai/mcp --scope user --header "Authorization: Bearer YOUR_QVERIS_API_KEY"
170+
```
171+
172+
Setup flow:
173+
174+
1. Create a key on [Dashboard / API Keys](/account?page=api-keys).
175+
2. Add the endpoint and Bearer header to your client. Store the key in a secret or environment variable when supported; never commit it.
176+
3. Reconnect the client and confirm `discover`, `inspect`, and `call` are visible.
177+
178+
The server validates the key when a session starts and binds that session to the credential. A `401` means the key is missing or invalid; a `503` means validation is temporarily unavailable. Start a new MCP session after changing the key. See the [Hosted MCP page](/hosted-mcp) for a copy-ready setup.
147179

148-
1. Create or select a QVeris API key.
149-
2. Copy the hosted MCP URL from the QVeris dashboard or docs.
150-
3. Add the hosted URL to your MCP client using its remote MCP configuration flow.
151-
4. Run `qveris mcp validate --target <client>` or the client's built-in tool list view and confirm `discover`, `inspect`, and `call` are visible.
180+
The local stdio package remains available for clients that do not support remote Streamable HTTP MCP.
152181

153182
---
154183

‎docs/zh-CN/mcp-server.md‎

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,43 @@ qveris mcp validate --target cursor --probe
141141

142142
## Hosted MCP
143143

144-
Hosted MCP 已列入规划，但当前接入路径不依赖托管端点。在正式发布托管端点前，请使用上文的 stdio server：`npx -y @qverisai/mcp`。
144+
QVeris 提供远程 Streamable HTTP MCP 托管服务，无需安装本地软件包或运行后台进程。如果端点暂时不可用，请在托管服务发布完成前继续使用上文的本地 stdio 软件包。
145145

146-
托管 MCP 端点可用后，接入流程会是：
146+
```text
147+
https://mcp.qveris.ai/mcp
148+
```
149+
150+
在支持远程 MCP 的客户端中添加服务地址，并在每次请求中发送 QVeris API 密钥：
151+
152+
```json
153+
{
154+
"mcpServers": {
155+
"qveris": {
156+
"type": "http",
157+
"url": "https://mcp.qveris.ai/mcp",
158+
"headers": {
159+
"Authorization": "Bearer YOUR_QVERIS_API_KEY"
160+
}
161+
}
162+
}
163+
}
164+
```
165+
166+
Claude Code 可直接通过命令行添加：
167+
168+
```bash
169+
claude mcp add --transport http qveris https://mcp.qveris.ai/mcp --scope user --header "Authorization: Bearer YOUR_QVERIS_API_KEY"
170+
```
171+
172+
接入步骤：
173+
174+
1. 在[控制台/API 密钥](/account?page=api-keys)创建密钥。
175+
2. 将服务地址和 Bearer 请求头添加到客户端。客户端支持时，请用密钥管理或环境变量保存 API 密钥，切勿提交到源代码仓库。
176+
3. 重新连接客户端，确认 `discover`、`inspect`、`call` 可见。
177+
178+
服务会在会话启动时验证并绑定密钥。`401` 表示密钥缺失或无效；`503` 表示验证服务暂时不可用。更换密钥后请新建 MCP 会话。可前往[托管 MCP 页面](/hosted-mcp)复制配置。
147179

148-
1. 创建或选择一个 QVeris API key。
149-
2. 从 QVeris 控制台或文档复制 hosted MCP URL。
150-
3. 按 MCP 客户端的远程 MCP 配置流程添加该 hosted URL。
151-
4. 运行 `qveris mcp validate --target <client>` 或使用客户端内置工具列表，确认 `discover`、`inspect`、`call` 可见。
180+
不支持远程 Streamable HTTP MCP 的客户端仍可使用本地 stdio 软件包。
152181

153182
---
154183

0 commit comments

Comments
 (0)