Skip to content

Commit f2f203d

Browse files
committed
Fix docs lint blockers for deployment
1 parent 3cb9543 commit f2f203d

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

benchmark_reports/zcp_mcp_tool_call_benchmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
| warmer_city_delta | 2821.0 | 4579.5 | 1758.5 | 1.62x | 100.0% | 100.0% |
1919
| shanghai_temp_f_and_humidity | 2565.0 | 3834.5 | 1269.5 | 1.49x | 100.0% | 100.0% |
2020
| average_three_city_temperature | 3116.0 | 5237.5 | 2121.5 | 1.68x | 100.0% | 100.0% |
21-
| more_humid_city_delta | 2830.0 | 4364.0 | 1534.0 | 1.54x | 100.0% | 100.0% |
21+
| more_humid_city_delta | 2830.0 | 4364.0 | 1534.0 | 1.54x | 100.0% | 100.0% |

docs/core_concepts_sampling_elicitation_roots_logging_tasks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Examples:
5252
- a backend asks the host to summarize retrieved context
5353
- a workflow uses a client-owned model to draft output before human review
5454

55-
### Design Guidance
55+
### Sampling Design Guidance
5656

5757
Prefer sampling for bounded, explicit decisions. Do not use it as a vague
5858
"think for a while" escape hatch. The server should still own workflow state
@@ -79,7 +79,7 @@ Use elicitation for:
7979
- URL handoff flows
8080
- interrupted task flows that later resume
8181

82-
### Design Guidance
82+
### Elicitation Design Guidance
8383

8484
Use elicitation only when the server genuinely lacks required input. Do not use
8585
it to offload validation or to patch over poor tool schemas.
@@ -120,7 +120,7 @@ Logging is useful for:
120120
- troubleshooting integration issues
121121
- explaining why a task paused or failed
122122

123-
### Design Guidance
123+
### Logging Design Guidance
124124

125125
Keep logs operational. They should help clients and operators understand server
126126
behavior, not duplicate business output that belongs in tool or task results.

docs/core_concepts_sampling_elicitation_roots_logging_tasks.zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Sampling 指的是服务端请求客户端运行时生成一条模型消息。
4848
- 某个后端要求 host 总结已检索到的上下文
4949
- 某个工作流在人工审核前,先用客户端拥有的模型生成草稿
5050

51-
### 设计建议
51+
### Sampling 设计建议
5252

5353
更推荐把 sampling 用于边界清晰、目标明确的决策,而不是把它当作模糊的“先想一会儿”逃生口。工作流状态和校验仍然应该由服务端负责。
5454

@@ -70,7 +70,7 @@ Elicitation 指的是服务端向客户端或用户请求更多信息。在 MCP
7070
- URL 跳转流程
7171
- 被中断后可恢复的 task 流
7272

73-
### 设计建议
73+
### Elicitation 设计建议
7474

7575
只有当服务端确实缺少必要输入时,才应使用 elicitation。不要用它来转移校验责任,也不要用它来掩盖糟糕的 tool schema。
7676

@@ -105,7 +105,7 @@ Logging 适合用来传递:
105105
- 集成问题排查信息
106106
- 为什么某个 task 被暂停或失败
107107

108-
### 设计建议
108+
### Logging 设计建议
109109

110110
日志应保持“运维语义”,它应该帮助客户端和操作者理解服务端行为,而不是重复那些本该属于 tool 或 task 结果里的业务输出。
111111

0 commit comments

Comments
 (0)