Skip to content

[azsdk-cli] Add compile-time analyzer to enforce Tool method return types #11565

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

Merged
benbp merged 11 commits into from
Aug 7, 2025
Merged

[azsdk-cli] Add compile-time analyzer to enforce Tool method return types #11565

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c49b031
Initial plan
Copilot Aug 6, 2025
9a6637b
Implement analyzer to enforce Tool method return types
Copilot Aug 6, 2025
1d0d945
Add documentation for MCP003 analyzer
Copilot Aug 6, 2025
d7673a8
Apply suggestion from @benbp
benbp Aug 6, 2025
740d80e
Apply suggestion from @benbp
benbp Aug 6, 2025
c480f2e
Change analyzer severity to Warning and remove ValueTask support
Copilot Aug 7, 2025
2228641
Simplify type checking to only allow primitive types and string
Copilot Aug 7, 2025
0cc11a9
Fix code to work as intended
benbp Aug 7, 2025
50dcc81
Add readme for mcp analyzers
benbp Aug 7, 2025
8b54beb
Enforce if statement syntax
benbp Aug 7, 2025
d2b51bc
Enforce if statement syntax. Fix tools namespacing
benbp Aug 7, 2025
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
Change analyzer severity to Warning and remove ValueTask support 
Co-authored-by: benbp <1020379+benbp@users.noreply.github.com>
  • Loading branch information
@benbp
Copilot and benbp committed Aug 7, 2025
commit c480f2efdb2a300ba8c3b84f4fbdfa10470aa000
14 changes: 1 addition & 13 deletions tools/azsdk-cli/Azure.Sdk.Tools.Cli.Analyzer/EnforceToolsReturnTypes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class EnforceToolsReturnTypesAnalyzer : DiagnosticAnalyzer
"Tool methods must return Response types, built-in value types, or string",
"Method '{0}' in Tools namespace must return a class implementing Response, a built-in value type, or string. Current return type: '{1}'.",
"Design",
DiagnosticSeverity.Error,
DiagnosticSeverity.Warning,
isEnabledByDefault: true);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
Expand Down Expand Up @@ -111,18 +111,6 @@ private static bool IsTaskType(ITypeSymbol type, out ITypeSymbol innerType)
return true;
}
}

// Check for ValueTask<T>
if (namedType.IsGenericType &&
(namedType.ConstructedFrom?.ToDisplayString() == "System.Threading.Tasks.ValueTask<T>" ||
namedType.Name == "ValueTask" && namedType.ContainingNamespace?.ToDisplayString() == "System.Threading.Tasks"))
{
if (namedType.TypeArguments.Length > 0)
{
innerType = namedType.TypeArguments[0];
return true;
}
}
}

return false;
Expand Down
Loading