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

Define the declarative input-schema synthesis algorithm (#declarative-api is currently a TODO)

未关闭
#210 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
html, json
领域
api

调研方向

Start with the synthesize a declarative JSON Schema object TODO in index.bs and the Input schema synthesis section of declarative-api-explainer.md. Review the existing declarative API attribute model and the open questions in this issue, then settle the mapping and edge cases with the editors. Done means the explainer and spec algorithms define consistent, deterministic schemas; the issue mentions a reference implementation and 11 test cases but does not identify their files.

由索引模型根据 Issue 内容生成。

描述

declarative
Summary

The declarative API needs a deterministic way to turn a <form> and its form-associated elements into a JSON Schema inputSchema, so agents can reliably fill out and submit declarative tools. Today this is unspecified in two places:

  • In the spec, #declarative-api — the synthesize a declarative JSON Schema object algorithm is just 1. TODO: Derive a conformant JSON Schema object from |form| and its form-associated elements.
  • In the explainer, the "Input schema synthesis" section is also marked TBD, noting we need to specify how elements like <input> and <select> reduce to a JSON Schema.

I've joined the Web Machine Learning Community Group and would like to contribute a concrete proposal for this algorithm. I've also written a reference implementation that passes 11 test cases (details at the bottom). Sharing here for feedback before opening any PRs. It's intentionally conservative and aligned with the attribute model already in the explainer (toolname, tooldescription, name, toolparamdescription).

Proposed top-level shape

A <form> reduces to:

{
  "type": "object",
  "properties": { /* one entry per included, named control */ },
  "required": [ /* names of controls carrying the `required` constraint */ ]
}
  • Only named controls are included; submit/reset/button/image and unnamed/disabled controls are skipped.
  • Property key = the control's name; description comes from toolparamdescription; a control's value maps to default.
  • Controls sharing one name (radio groups, multi-checkboxes) are merged into a single property.
Proposed control → schema mapping
Control JSON Schema Constraints
text / search / tel / password {"type":"string"} minlength→minLength, maxlength→maxLength, pattern→pattern
email {"type":"string","format":"email"} multiple → array of email strings
url {"type":"string","format":"uri"}
number {"type":"number"} min→minimum, max→maximum, numeric step→multipleOf (omit for any)
range {"type":"number"} minimum default 0, maximum default 100
date / datetime-local / time {"type":"string","format":"date" | "date-time" | "time"}
month / week / color {"type":"string","pattern": …} no standard format exists
checkbox (single) {"type":"boolean"}
radio group {"type":"string","enum":[values]} required if any member is required
checkbox group {"type":"array","items":{"enum":[values]},"uniqueItems":true}
<select> / <select multiple> {"type":"string","enum":[…]} / {"type":"array",…} option text used when value absent
<textarea> {"type":"string"} minlength/maxlength
Algorithm (sketch)

Two algorithms, mirroring the split of concerns:

  1. synthesize a declarative JSON Schema object (form-level): collect submittable named controls, group them by name, build properties and required.
  2. map a form control to a JSON Schema property (control-level): switch on the control's type per the table above, applying string/numeric constraint helpers.

I have these written out in full Bikeshed-style steps and am happy to paste them here or bring them directly in a PR, whichever the editors prefer.

Worked example
<form toolname="search-cars" tooldescription="Perform a car make/model search">
  <input type=text name="make" toolparamdescription="The vehicle's make" required>
  <input type=text name="model" toolparamdescription="The vehicle's model" required>
  <input type=number name="max_price" min="0" max="200000" step="500">
  <select name="fuel"><option>Petrol<option>Diesel<option value="ev">Electric</select>
</form>

synthesizes to:

{
  "type": "object",
  "properties": {
    "make":      { "type": "string", "description": "The vehicle's make" },
    "model":     { "type": "string", "description": "The vehicle's model" },
    "max_price": { "type": "number", "minimum": 0, "maximum": 200000, "multipleOf": 500 },
    "fuel":      { "type": "string", "enum": ["Petrol", "Diesel", "ev"] }
  },
  "required": ["make", "model"]
}
Open questions (would like editor guidance)
  1. <input type=file> — binary uploads; defer until multimodal tool inputs (#41, #86) are resolved?
  2. <input type=hidden> — exclude (not agent-fillable), or expose as a fixed const?
  3. disabled / readonly — exclude disabled (not submitted); what about readonly?
  4. <datalist> — non-restrictive suggestions; map to examples rather than enum?
  5. step + min — strictly a discrete value set; is multipleOf an acceptable approximation, or should small ranges emit an enum?
  6. month / week — use an explicit regex pattern, or reference HTML's "valid month/week string" microsyntax via a note?
  7. format as assertion — JSON Schema treats format as annotation by default; should the spec require agents to treat email/uri/date as assertions?
Reference implementation & tests

To validate the design I wrote a small reference implementation of both algorithms and a test suite (11 cases: the example above, string constraints, all format types, email multiple, range defaults, single checkbox, radio group, checkbox group, select multiple, excluded/hidden/file/disabled controls, and textarea/color/month). All 11 pass. I'm glad to share the code, and — if useful — to contribute these as Web Platform Tests so the feature is testable end-to-end.

Proposed next steps

If this direction looks reasonable, I'd open two small PRs once the open questions settle:

  1. declarative-api-explainer.md — the mapping table + worked examples.
  2. index.bs — the two algorithms replacing the 1. TODO.

Feedback very welcome, especially on the open questions above. Thanks!

主要语言
Bikeshed
星标
4.7k
派生
328
平均合并
2 天 15 小时
30 天内合并 PR
16

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

webmachinelearning/webmcp 的其他 Issue

查看 webmachinelearning/webmcp 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

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