Skip to content

Commit b08a610

Browse files
authored
Update instructions, add cursor install link (#159)
closes #156
1 parent 1d9d60c commit b08a610

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

pkgs/dart_mcp_server/README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
The Dart Tooling MCP Server exposes Dart and Flutter development tool actions to compatible AI-assistant clients.
22

3+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=dart_tooling&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoiZGFydCBtY3Atc2VydmVyIC0tZXhwZXJpbWVudGFsLW1jcC1zZXJ2ZXIgLS1mb3JjZS1yb290cy1mYWxsYmFjayJ9)
4+
35
## Status
46

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

39+
If you are using a client that claims it supports roots but does not actually
40+
set them, pass `--force-roots-fallback` which will instead enable tools for
41+
managing the roots.
42+
43+
### Running from the SDK
44+
45+
For most users, you should just use the `dart mcp-server` command. For now you
46+
also need to provide `--experimental-mcp-server` in order for the command to
47+
succeed.
48+
49+
### Running a local checkout
50+
3751
The server entrypoint lives at `bin/main.dart`, and can be ran however you
3852
choose, but the easiest way is to run it as a globally activated package.
3953

@@ -85,20 +99,26 @@ dart run dart_mcp_examples:workflow_client --server dart_mcp_server
8599

86100
### With Cursor
87101

88-
Go to Cursor -> Settings -> Cursor Settings and select "MCP".
102+
The following button should work for most users:
103+
104+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=dart_tooling&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoiZGFydCBtY3Atc2VydmVyIC0tZXhwZXJpbWVudGFsLW1jcC1zZXJ2ZXIgLS1mb3JjZS1yb290cy1mYWxsYmFjayJ9)
105+
106+
To manually install it, go to Cursor -> Settings -> Cursor Settings and select "MCP".
89107

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

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

96-
```yaml
112+
```json
97113
{
98114
"mcpServers": {
99115
"dart_mcp": {
100-
"command": "dart_mcp_server",
101-
"args": []
116+
"command": "dart",
117+
"args": [
118+
"mcp-server",
119+
"--experimental-mcp-server",
120+
"--force-roots-fallback"
121+
]
102122
}
103123
}
104124
}

0 commit comments

Comments
 (0)