SKILL.md
Adding Features to dartmcpserver
Follow these instructions when adding new tools, prompts, or other capabilities to the dartmcpserver.
1. Locate or Create a Mixin
All server features are implemented as mixins on the DartMCPServer at pkgs/dartmcpserver/lib/src/server.dart.
- Check existing mixins: Look under
pkgs/dartmcpserver/lib/src/mixins/
to see if your feature fits into an existing category (e.g., analyzer.dart, pub.dart).
- Create a new mixin: If your feature is distinct, create a new file in that
directory, following the patterns in existing mixins. Make sure to include a copyright header at the top of the file, with the current year.
2. Implementation Details
- Registration: Tools, prompts, etc should be registered in the
initialize
method of the mixin, which is an override and must call super.initialize().
- Parameter Names: When adding new arguments to tools or prompts, always
add a constant to the ParameterNames extension in pkgs/dartmcpserver/lib/src/utils/names.dart and use that constant instead of hardcoding string literals in your tool parsing and schema.
3. Testing
Always add tests for any new features.
- Test Harness: Use the
TestHarnessclass located in
pkgs/dartmcpserver/test/test_harness.dart.
- Existing Tests: Look at
pkgs/dartmcpserver/test/tools/for examples of
how to test specific tools.
- Enhance Harness: If the current
TestHarnesslacks functionality needed
for your test, feel free to add it.
4. Verification
- Run tests
- Run analysis
- Format the code
5. Documentation
- Run the
pkgs/dartmcpserver/tool/update_readme.dartscript to update the
README.md file with any new features, it must be ran from the pkgs/dartmcpserver directory.
- Apply any other manual edits to the
README.mdfile as needed. - Update the
CHANGELOG.mdfile to include any user facing updates.
6. Update this skill
- Update this
SKILL.mdfile if that would be helpful for future features.