Skip to content

Validate implementation wire fields #258

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.

Sign up for GitHub

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

Closed
leehack wants to merge 1 commit into from
Closed

Validate implementation wire fields #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
112 changes: 96 additions & 16 deletions lib/src/types/initialization.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,69 @@ Map<String, dynamic>? _asJsonObject(dynamic value) {
throw FormatException('Expected object capability, got ${value.runtimeType}');
}

String _readRequiredString(Object? value, String field) {
if (value is String) {
return value;
}
throw FormatException('$field must be a string');
}

String? _readOptionalPresentString(
Map<String, dynamic> json,
String key,
String field,
) {
if (!json.containsKey(key)) {
return null;
}
return _readRequiredString(json[key], field);
}

bool _isAbsoluteUri(String value) {
return Uri.tryParse(value)?.hasScheme ?? false;
}

String? _readOptionalPresentUriString(
Map<String, dynamic> json,
String key,
String field,
) {
final value = _readOptionalPresentString(json, key, field);
if (value == null) {
return null;
}
if (!_isAbsoluteUri(value)) {
throw FormatException('$field must be an absolute URI');
}
return value;
}

void _validateAbsoluteUriString(String value, String field) {
if (!_isAbsoluteUri(value)) {
throw ArgumentError.value(value, field, 'must be an absolute URI');
}
}

List<McpIcon>? _readOptionalIconList(
Map<String, dynamic> json,
String key,
String field,
) {
if (!json.containsKey(key)) {
return null;
}

final value = json[key];
if (value is! List) {
throw FormatException('$field must be a list of objects');
}

return [
for (var i = 0; i < value.length; i++)
McpIcon.fromJson(readJsonObject(value[i], '$field[$i]')),
];
}

Map<String, dynamic>? _asStrictJsonObject(Object? value, String field) {
if (value == null) {
return null;
Expand Down Expand Up @@ -150,25 +213,42 @@ class Implementation {

factory Implementation.fromJson(Map<String, dynamic> json) {
return Implementation(
name: json['name'] as String,
title: json['title'] as String?,
version: json['version'] as String,
description: json['description'] as String?,
icons: (json['icons'] as List<dynamic>?)
?.map((e) => McpIcon.fromJson(e as Map<String, dynamic>))
.toList(),
websiteUrl: json['websiteUrl'] as String?,
name: _readRequiredString(json['name'], 'Implementation.name'),
title: _readOptionalPresentString(
json,
'title',
'Implementation.title',
),
version: _readRequiredString(json['version'], 'Implementation.version'),
description: _readOptionalPresentString(
json,
'description',
'Implementation.description',
),
icons: _readOptionalIconList(json, 'icons', 'Implementation.icons'),
websiteUrl: _readOptionalPresentUriString(
json,
'websiteUrl',
'Implementation.websiteUrl',
),
);
}

Map<String, dynamic> toJson() => {
'name': name,
if (title != null) 'title': title,
'version': version,
if (description != null) 'description': description,
if (icons != null) 'icons': icons?.map((e) => e.toJson()).toList(),
if (websiteUrl != null) 'websiteUrl': websiteUrl,
};
Map<String, dynamic> toJson() {
final websiteUrl = this.websiteUrl;
if (websiteUrl != null) {
_validateAbsoluteUriString(websiteUrl, 'Implementation.websiteUrl');
}

return {
'name': name,
if (title != null) 'title': title,
'version': version,
if (description != null) 'description': description,
if (icons != null) 'icons': icons?.map((e) => e.toJson()).toList(),
if (websiteUrl != null) 'websiteUrl': websiteUrl,
};
}
}

/// Describes capabilities related to root resources (e.g., workspace folders).
Expand Down
95 changes: 95 additions & 0 deletions test/types_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,101 @@ void main() {
);
});

test('Implementation parses stable wire fields', () {
final implementation = Implementation.fromJson({
'name': 'test-client',
'title': 'Test Client',
'version': '1.0.0',
'description': 'A test MCP client',
'icons': [
{
'src': 'https://example.com/icon.png',
'theme': 'light',
},
],
'websiteUrl': 'https://example.com',
});

expect(implementation.name, equals('test-client'));
expect(implementation.title, equals('Test Client'));
expect(implementation.version, equals('1.0.0'));
expect(implementation.description, equals('A test MCP client'));
expect(implementation.icons!.single.theme, equals(IconTheme.light));
expect(implementation.websiteUrl, equals('https://example.com'));
expect(implementation.toJson(), {
'name': 'test-client',
'title': 'Test Client',
'version': '1.0.0',
'description': 'A test MCP client',
'icons': [
{
'src': 'https://example.com/icon.png',
'theme': 'light',
},
],
'websiteUrl': 'https://example.com',
});
});

test('Implementation rejects malformed stable wire fields', () {
void expectInvalid(Map<String, dynamic> json) {
expect(
() => Implementation.fromJson(json),
throwsA(isA<FormatException>()),
);
}

expectInvalid({});
expectInvalid({'name': 'test-client'});
expectInvalid({'name': 1, 'version': '1.0.0'});
expectInvalid({'name': 'test-client', 'version': 1});
expectInvalid({'name': 'test-client', 'version': '1.0.0', 'title': null});
expectInvalid({'name': 'test-client', 'version': '1.0.0', 'title': 1});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'description': null,
});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'description': 1,
});
expectInvalid({'name': 'test-client', 'version': '1.0.0', 'icons': null});
expectInvalid({'name': 'test-client', 'version': '1.0.0', 'icons': {}});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'icons': [null],
});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'websiteUrl': null,
});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'websiteUrl': 1,
});
expectInvalid({
'name': 'test-client',
'version': '1.0.0',
'websiteUrl': 'example.com',
});
});

test('Implementation validates website URL during serialization', () {
expect(
() => const Implementation(
name: 'test-client',
version: '1.0.0',
websiteUrl: 'example.com',
).toJson(),
throwsA(isA<ArgumentError>()),
);
});

test('ImageContent supports annotations and meta', () {
final content = const ImageContent(
data: 'base64data',
Expand Down