Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

docs: add a protocol reference page for custom clients

已关闭
  • 哪里不对？
#286 2 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@kachamsiddarth 已经在做这个了。

开始于 2026年10月21日。

评估

这个 Issue 还没有评估数据。

描述

documentation good first issue hacktoberfest website

The server speaks protocol v1 now (#285), but the only description of it is a section of server/setup.mdx. Anyone writing their own client (a mobile app, a CLI, a different widget) needs one page that lists every part, every error code and a request they can paste into a terminal. This issue is that page.

What to do

  • New page website/src/content/docs/server/protocol.mdx, title Protocol, added to the Server sidebar in website/astro.config.mjs (lines 121 to 128), after Setup. Cover:
    • How to ask for v1: "protocol": 1 in the body, or the x-chatcops-protocol: 1 header. The response then has x-chatcops-protocol: 1. Without either, the server answers in the 0.5 format, which goes away in 1.0.
    • The request body: the fields in chatRequestSchema (packages/server/src/config.ts, lines 101 to 123) with their limits, plus protocol.
    • Every part in WirePart (packages/core/src/protocol/v1.ts, lines 50 to 99), one short paragraph or table row each, with an example line. Say which ones the server sends today (start, text-start, text-delta, text-end, tool-call, tool-result, lead-captured, error, finish) and that the others (source, handoff, agent-message, suggestions) are reserved for later features.
    • Framing: one data: <json> line per part, data: [DONE] once at the end, : ping comments after 10 s of silence, clients ignore unknown part types, and a stream without finish was cut off.
    • Errors before the stream: every status and code from packages/core/src/protocol/errors.ts, with the JSON body shape and Retry-After.
    • Errors during the stream: the error part's codes, retryable, and scope for budget_exceeded.
    • A curl example: curl -N -X POST http://localhost:3001/chat -H 'Content-Type: application/json' -d '{"protocol":1,"conversationId":"test-1","message":"Hi"}', followed by what it prints.
    • import type { WirePart } from '@chatcops/core/protocol' for TypeScript clients.
  • In website/src/content/docs/server/setup.mdx, keep the "Response format" section short: the two formats in one paragraph, and a link to the new page for the details. Move the parts list and the status table there.

Where to look

  • packages/server/src/http.ts, which does negotiation, statuses, pings and [DONE]
  • packages/server/tests/http.test.ts for real request and response examples
  • packages/core/src/protocol/ for the types and the status map

Acceptance criteria

  • New server/protocol.mdx in the sidebar, covering the points above
  • Every part and error code in v1.ts and errors.ts is on the page, and nothing that isn't
  • The curl example's output on the page is real. You don't need an API key: run the Express example (packages/server/src/examples/express-server.ts) with provider: scriptedProvider([textStep('Hello!')]) from @chatcops/core/testing/provider, and don't commit that change
  • pnpm --filter @chatcops/website build succeeds
  • Changeset: pnpm changeset --empty (docs only)

Please get this merged by Dec 8, since the v0.6 release notes link to it.

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

主要语言
TypeScript
星标
13
派生
7
平均合并
3 小时 33 分钟
30 天内合并 PR
176

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

codercops/chatcops 的其他 Issue

查看 codercops/chatcops 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。