Skip to content

Add runtime errors resource and tool to clear errors. #94

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

Merged
merged 15 commits into from
May 2, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
add more constants for map keys
  • Loading branch information
jakemac53 committed May 2, 2025
commit 0e759300bd9f149de345711fdd09f5da3e8721d6
11 changes: 6 additions & 5 deletions pkgs/dart_tooling_mcp_server/lib/src/mixins/analyzer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import 'package:language_server_protocol/protocol_generated.dart' as lsp;
import 'package:meta/meta.dart';

import '../lsp/wire_format.dart';
import '../utils/constants.dart';

/// Mix this in to any MCPServer to add support for analyzing Dart projects.
///
Expand Down Expand Up @@ -245,7 +246,7 @@ base mixin DartAnalyzerSupport
for (var entry in diagnostics.entries) {
for (var diagnostic in entry.value) {
final diagnosticJson = diagnostic.toJson();
diagnosticJson['uri'] = entry.key.toString();
diagnosticJson[ParameterNames.uri] = entry.key.toString();
messages.add(TextContent(text: jsonEncode(diagnosticJson)));
}
}
Expand All @@ -263,7 +264,7 @@ base mixin DartAnalyzerSupport
final errorResult = await _ensurePrerequisites(request);
if (errorResult != null) return errorResult;

final query = request.arguments!['query'] as String;
final query = request.arguments![ParameterNames.query] as String;
final result = await _lspConnection.sendRequest(
lsp.Method.workspace_symbol.toString(),
lsp.WorkspaceSymbolParams(query: query).toJson(),
Expand Down Expand Up @@ -306,7 +307,7 @@ base mixin DartAnalyzerSupport
);
diagnostics[diagnosticParams.uri] = diagnosticParams.diagnostics;
log(LoggingLevel.debug, {
'uri': diagnosticParams.uri,
ParameterNames.uri: diagnosticParams.uri,
'diagnostics':
diagnosticParams.diagnostics.map((d) => d.toJson()).toList(),
});
Expand Down Expand Up @@ -369,14 +370,14 @@ base mixin DartAnalyzerSupport
description: 'Look up a symbol or symbols in all workspaces by name.',
inputSchema: Schema.object(
properties: {
'query': Schema.string(
ParameterNames.query: Schema.string(
description:
'Queries are matched based on a case-insensitive partial name '
'match, and do not support complex pattern matching, regexes, '
'or scoped lookups.',
),
},
required: ['query'],
required: [ParameterNames.query],
),
annotations: ToolAnnotations(title: 'Project search', readOnlyHint: true),
);
Expand Down
10 changes: 6 additions & 4 deletions pkgs/dart_tooling_mcp_server/lib/src/mixins/dtd.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import 'package:meta/meta.dart';
import 'package:vm_service/vm_service.dart';
import 'package:vm_service/vm_service_io.dart';

import '../utils/constants.dart';

/// Mix this in to any MCPServer to add support for connecting to the Dart
/// Tooling Daemon and all of its associated functionality (see
/// https://pub.dev/packages/dtd).
Expand Down Expand Up @@ -149,7 +151,7 @@ base mixin DartToolingDaemonSupport
return _dtdAlreadyConnected;
}

if (request.arguments?['uri'] == null) {
if (request.arguments?[ParameterNames.uri] == null) {
return CallToolResult(
isError: true,
content: [
Expand All @@ -160,7 +162,7 @@ base mixin DartToolingDaemonSupport

try {
_dtd = await DartToolingDaemon.connect(
Uri.parse(request.arguments!['uri'] as String),
Uri.parse(request.arguments![ParameterNames.uri] as String),
);
unawaited(_dtd!.done.then((_) async => await _resetDtd()));

Expand Down Expand Up @@ -502,8 +504,8 @@ base mixin DartToolingDaemonSupport
'command. Do not just make up a random URI to pass.',
annotations: ToolAnnotations(title: 'Connect to DTD', readOnlyHint: true),
inputSchema: Schema.object(
properties: {'uri': Schema.string()},
required: const ['uri'],
properties: {ParameterNames.uri: Schema.string()},
required: const [ParameterNames.uri],
),
);

Expand Down
2 changes: 2 additions & 0 deletions pkgs/dart_tooling_mcp_server/lib/src/utils/constants.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ extension ParameterNames on Never {
static const command = 'command';
static const packageName = 'packageName';
static const paths = 'paths';
static const query = 'query';
static const root = 'root';
static const roots = 'roots';
static const uri = 'uri';
}
3 changes: 2 additions & 1 deletion pkgs/dart_tooling_mcp_server/test/test_harness.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import 'package:async/async.dart';
import 'package:dart_mcp/client.dart';
import 'package:dart_tooling_mcp_server/src/mixins/dtd.dart';
import 'package:dart_tooling_mcp_server/src/server.dart';
import 'package:dart_tooling_mcp_server/src/utils/constants.dart';
import 'package:dtd/dtd.dart';
import 'package:path/path.dart' as p;
import 'package:process/process.dart';
Expand Down Expand Up @@ -116,7 +117,7 @@ class TestHarness {
final result = await callToolWithRetry(
CallToolRequest(
name: connectTool.name,
arguments: {'uri': fakeEditorExtension.dtdUri},
arguments: {ParameterNames.uri: fakeEditorExtension.dtdUri},
),
);

Expand Down
5 changes: 3 additions & 2 deletions pkgs/dart_tooling_mcp_server/test/tools/analyzer_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'dart:io';

import 'package:dart_mcp/server.dart';
import 'package:dart_tooling_mcp_server/src/mixins/analyzer.dart';
import 'package:dart_tooling_mcp_server/src/utils/constants.dart';
import 'package:test/test.dart';
import 'package:test_descriptor/test_descriptor.dart' as d;

Expand Down Expand Up @@ -96,7 +97,7 @@ void main() {
final result = await testHarness.callToolWithRetry(
CallToolRequest(
name: DartAnalyzerSupport.resolveWorkspaceSymbolTool.name,
arguments: {'query': 'DartAnalyzerSupport'},
arguments: {ParameterNames.query: 'DartAnalyzerSupport'},
),
);
expect(result.isError, isNot(true));
Expand Down Expand Up @@ -130,7 +131,7 @@ void main() {
final result = await testHarness.callToolWithRetry(
CallToolRequest(
name: DartAnalyzerSupport.resolveWorkspaceSymbolTool.name,
arguments: {'query': 'DartAnalyzerSupport'},
arguments: {ParameterNames.query: 'DartAnalyzerSupport'},
),
expectError: true,
);
Expand Down
5 changes: 3 additions & 2 deletions pkgs/dart_tooling_mcp_server/test/tools/dtd_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import 'dart:convert';
import 'package:async/async.dart';
import 'package:dart_mcp/server.dart';
import 'package:dart_tooling_mcp_server/src/mixins/dtd.dart';
import 'package:dart_tooling_mcp_server/src/utils/constants.dart';
import 'package:test/test.dart';
import 'package:vm_service/vm_service.dart';

Expand Down Expand Up @@ -347,7 +348,7 @@ void main() {
await resourceUpdatedQueue.next,
isA<ResourceUpdatedNotification>().having(
(n) => n.uri,
'uri',
ParameterNames.uri,
resource.uri,
),
);
Expand All @@ -371,7 +372,7 @@ void main() {
await resourceUpdatedQueue.next,
isA<ResourceUpdatedNotification>().having(
(n) => n.uri,
'uri',
ParameterNames.uri,
resource.uri,
),
);
Expand Down