Skip to content

Update instructions, add cursor install link #159

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions pkgs/dart_mcp_server/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
The Dart Tooling MCP Server exposes Dart and Flutter development tool actions to compatible AI-assistant clients.

[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=dart_tooling&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoiZGFydCBtY3Atc2VydmVyIC0tZXhwZXJpbWVudGFsLW1jcC1zZXJ2ZXIgLS1mb3JjZS1yb290cy1mYWxsYmFjayJ9)

## Status

WIP. This package is still experimental and is likely to evolve quickly.
Expand Down Expand Up @@ -34,6 +36,18 @@ This server only supports the STDIO transport mechanism and runs locally on
your machine. Many of the tools require that your MCP client has `roots`
support, and usage of the tools is scoped to only these directories.

If you are using a client that claims it supports roots but does not actually
set them, pass `--force-roots-fallback` which will instead enable tools for
managing the roots.

### Running from the SDK

For most users, you should just use the `dart mcp-server` command. For now you
also need to provide `--experimental-mcp-server` in order for the command to
succeed.

### Running a local checkout

The server entrypoint lives at `bin/main.dart`, and can be ran however you
choose, but the easiest way is to run it as a globally activated package.

Expand Down Expand Up @@ -85,20 +99,26 @@ dart run dart_mcp_examples:workflow_client --server dart_mcp_server

### With Cursor

Go to Cursor -> Settings -> Cursor Settings and select "MCP".
The following button should work for most users:

[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=dart_tooling&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoiZGFydCBtY3Atc2VydmVyIC0tZXhwZXJpbWVudGFsLW1jcC1zZXJ2ZXIgLS1mb3JjZS1yb290cy1mYWxsYmFjayJ9)

To manually install it, go to Cursor -> Settings -> Cursor Settings and select "MCP".

Then, click "Add new global MCP server". Assuming you have already globally
activated the package and it is on your path, you can add
`dart_mcp_server` as the command.
Then, click "Add new global MCP server".

If you are directly editing your mcp.json file, it should look like this:

```yaml
```json
{
"mcpServers": {
"dart_mcp": {
"command": "dart_mcp_server",
"args": []
"command": "dart",
"args": [
"mcp-server",
"--experimental-mcp-server",
"--force-roots-fallback"
]
}
}
}
Expand Down