[Capability] Describe nullable parameters with `anyOf` instead of a `type` array?

Đang mở
#631 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
json, php
Lĩnh vực
api, backend

Hướng nghiên cứu

Start in SchemaGenerator, where a nullable parameter currently produces a type array such as ["null", "string"]; find the branch that builds that array and the tests covering nullable scalars, enums, arrays and objects. The open question is a design one, so the first deliverable is a maintainer answer on whether anyOf should be default or opt-in before any patch. Done means every nullable parameter shape is covered and existing schema tests are updated alongside the new behaviour.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

For a nullable parameter, SchemaGenerator emits a type array. With mcp/sdk 0.9.0, the ?string $company = null parameter of a tool gets:

{"type": ["null", "string"], "description": "The company of the speaker", "default": null}

MCP Inspector 2 then reports "Schema portability: 0 errors, 1 warning" and suggests {"anyOf": [{"type": "null"}, {"type": "string"}]}. That rule is a warning on purpose (schemaLint.ts, modelcontextprotocol/inspector#2286). The array form is what OpenAI recommends. It only costs portability to clients that map tool schemas onto a dialect with a single type.

What the providers document:

  • OpenAI: "it is possible to emulate an optional parameter by using a union type with null", with "type": ["string", "null"] in the examples. anyOf works too, except at the root.
  • Anthropic: strict tool use supports anyOf, and counts anyOf and type arrays the same in its limit on union types.
  • Gemini: the parameters of a function declaration use "a select subset of an OpenAPI 3.0 schema object". Its type is a single value, with anyOf, nullable and a NULL type. So only the anyOf form maps onto it. parametersJsonSchema takes JSON Schema instead.

Switching to anyOf would change the schema of every nullable parameter, including enums, arrays and objects, and clients that read type wouldn't find it anymore. So I'd rather ask first. Would you take a PR that emits anyOf for nullable parameters, maybe as an option of SchemaGenerator?

Found with the submit_proposal tool of the MCP server of the Symfony showcase app.

Ngôn ngữ chính
PHP
Star
1.7k
Fork
206
Merge trung bình
1 ngày 17 giờ
Pull request đã merge (30 ngày)
102

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của modelcontextprotocol/php-sdk

Tất cả issue của modelcontextprotocol/php-sdk

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.