Add support for emitting usage as a JSON schema #897
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Vendor a copy of a library defining a JSON schema API which can output as a `Map<String, Object?>`. - Add a `jsonSchema` getter on `ArgParser` which is similar to `usage` but outputs a schema instead of help text. Clients can manually support a `--json-help` or similar argument in the same way they support `--help`.
PR Health
Breaking changes
|
| Package | Change | Current Version | New Version | Needed Version | Looking good? |
|---|---|---|---|---|---|
| args | Breaking | 2.7.0 | 2.7.0 | 3.0.0 Got "2.7.0" expected >= "3.0.0" (breaking changes) |
This check can be disabled by tagging the PR with skip-breaking-check.
Changelog Entry ❗
| Package | Changed Files |
|---|---|
| package:args | pkgs/args/lib/src/allow_anything_parser.dart pkgs/args/lib/src/arg_parser.dart pkgs/args/lib/src/json_schema.dart |
Changes to files need to be accounted for in their respective changelogs.
This check can be disabled by tagging the PR with skip-changelog-check.
Coverage ⚠️
| File | Coverage |
|---|---|
| pkgs/args/lib/src/allow_anything_parser.dart | 💔 72 % ⬇️ 4 % |
| pkgs/args/lib/src/arg_parser.dart | 💚 95 % ⬆️ 1 % |
| pkgs/args/lib/src/json_schema.dart | 💚 17 % |
This check for test coverage is informational (issues shown here will not fail the PR).
This check can be disabled by tagging the PR with skip-coverage-check.
API leaks ✔️
The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
| Package | Leaked API symbols |
|---|
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
| Files |
|---|
| no missing headers |
All source files should start with a license header.
jakemac53
approved these changes
Jun 16, 2025
| // for details. All rights reserved. Use of this source code is governed by a | ||
| // BSD-style license that can be found in the LICENSE file. | ||
|
|
||
| // Copied from https://github.com/dart-lang/ai/blob/failures-only/pkgs/dart_mcp/lib/src/api/tools.dart |
There was a problem hiding this comment.
Suggested change
| // Copied from https://github.com/dart-lang/ai/blob/failures-only/pkgs/dart_mcp/lib/src/api/tools.dart | |
| // Copied from https://github.com/dart-lang/ai/blob/main/pkgs/dart_mcp/lib/src/api/tools.dart |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
as a
Map<String, Object?>.jsonSchemagetter onArgParserwhich is similar tousagebut outputs a schema instead of help text.
Clients can manually support a
--json-helpor similar argument in thesame way they support
--help.