Skip to content

add a CI check that the readme file is up-to-date #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

devoncarew
Copy link
Member

@devoncarew devoncarew commented Jun 25, 2025

Note that this PR also changes the format of the list of tools; it adds some categorization (we have a bunch of tools now); https://github.com/dart-lang/ai/blob/f8fb7408f39ac9dfa1d83ad0ebb4b0934e2cd8a9/pkgs/dart_mcp_server/README.md .


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

@github-actions github-actions bot added type-infra A repository infrastructure change or enhancement package:dart_mcp_server labels Jun 25, 2025
Copy link

PR Health

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

@devoncarew
Copy link
Member Author

Hmm, it looks like dart pub get for this package takes 1m 52s. I expect that's due to the git dep on the dart-lang/sdk repo (to get the language_server_protocol package).

@devoncarew devoncarew requested a review from kenzieschmoll June 26, 2025 20:34
@@ -179,6 +179,13 @@ base mixin DashCliSupport on ToolsSupport, LoggingSupport, RootsTrackingSupport
);
}

static final List<Tool> allTools = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: consider looping through this list in the initialize method so that it is less likely a new tool is added to initialize and not added here. You'd have to store that tools with their associated callback here.

Comment on lines +29 to +30
buf.writeln('### $category');
buf.writeln('');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: use cascades

@jakemac53
Copy link
Contributor

Hmm, it looks like dart pub get for this package takes 1m 52s. I expect that's due to the git dep on the dart-lang/sdk repo (to get the language_server_protocol package).

Yeah it is, no good way to avoid it that I am aware of. We could depend on a specific hash and that might get us a cache hit (if we also cache the pub cache on GitHub actions), so it would speed up CI a fair bit.

- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c

- run: dart pub get
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could just merge this into the job above to avoid the extra setup work 🤷‍♂️ . This repo isn't large enough to really need multiple jobs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:dart_mcp_server type-infra A repository infrastructure change or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants