Skip to content

refactor: use annotations to determine if tool should be included #38

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
cgrinds merged 1 commit into from
Feb 20, 2026
Merged

refactor: use annotations to determine if tool should be included #38

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
78 changes: 35 additions & 43 deletions server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,54 +65,42 @@ func (a *App) createMCPServer() *mcp.Server {
Logger: a.logger,
})

addTool(server, "list_registered_clusters", descriptions.ListClusters, readOnlyAnnotation, a.ListClusters)
addTool(a, server, "list_registered_clusters", descriptions.ListClusters, readOnlyAnnotation, a.ListClusters)

// operation on Volume object
addTool(server, "list_volumes", descriptions.ListVolumes, readOnlyAnnotation, a.ListVolumes)
if !a.options.ReadOnly {
addTool(server, "create_volume", descriptions.CreateVolume, createAnnotation, a.CreateVolume)
addTool(server, "update_volume", descriptions.UpdateVolume, updateAnnotation, a.UpdateVolume)
addTool(server, "delete_volume", descriptions.DeleteVolume, deleteAnnotation, a.DeleteVolume)
}
addTool(a, server, "list_volumes", descriptions.ListVolumes, readOnlyAnnotation, a.ListVolumes)
addTool(a, server, "create_volume", descriptions.CreateVolume, createAnnotation, a.CreateVolume)
addTool(a, server, "update_volume", descriptions.UpdateVolume, updateAnnotation, a.UpdateVolume)
addTool(a, server, "delete_volume", descriptions.DeleteVolume, deleteAnnotation, a.DeleteVolume)

// operation on Snapshot Policy object
addTool(server, "list_snapshot_policies", descriptions.ListSnapshotPolicy, readOnlyAnnotation, a.ListSnapshotPolicies)
if !a.options.ReadOnly {
addTool(server, "create_snapshot_policy", descriptions.CreateSnapshotPolicy, createAnnotation, a.CreateSnapshotPolicy)
addTool(server, "delete_snapshot_policy", descriptions.DeleteSnapshotPolicy, deleteAnnotation, a.DeleteSnapshotPolicy)
addTool(server, "create_schedule", descriptions.CreateSchedule, createAnnotation, a.CreateSchedule)
}
addTool(a, server, "list_snapshot_policies", descriptions.ListSnapshotPolicy, readOnlyAnnotation, a.ListSnapshotPolicies)
addTool(a, server, "create_snapshot_policy", descriptions.CreateSnapshotPolicy, createAnnotation, a.CreateSnapshotPolicy)
addTool(a, server, "delete_snapshot_policy", descriptions.DeleteSnapshotPolicy, deleteAnnotation, a.DeleteSnapshotPolicy)
addTool(a, server, "create_schedule", descriptions.CreateSchedule, createAnnotation, a.CreateSchedule)

// operation on QoS Policy object
addTool(server, "list_qos_policies", descriptions.ListQoSPolicy, readOnlyAnnotation, a.ListQoSPolicies)
if !a.options.ReadOnly {
addTool(server, "create_qos_policy", descriptions.CreateQoSPolicy, createAnnotation, a.CreateQoSPolicy)
addTool(server, "update_qos_policy", descriptions.UpdateQoSPolicy, updateAnnotation, a.UpdateQosPolicy)
addTool(server, "delete_qos_policy", descriptions.DeleteQoSPolicy, deleteAnnotation, a.DeleteQoSPolicy)
}
addTool(a, server, "list_qos_policies", descriptions.ListQoSPolicy, readOnlyAnnotation, a.ListQoSPolicies)
addTool(a, server, "create_qos_policy", descriptions.CreateQoSPolicy, createAnnotation, a.CreateQoSPolicy)
addTool(a, server, "update_qos_policy", descriptions.UpdateQoSPolicy, updateAnnotation, a.UpdateQosPolicy)
addTool(a, server, "delete_qos_policy", descriptions.DeleteQoSPolicy, deleteAnnotation, a.DeleteQoSPolicy)

// NFS (lint:gocritic)
// operation on NFS Export Policy object
addTool(server, "list_nfs_export_policies", descriptions.ListNFSExportPolicy, readOnlyAnnotation, a.ListNFSExportPolicies)
if !a.options.ReadOnly {
addTool(server, "create_nfs_export_policies", descriptions.CreateNFSExportPolicy, createAnnotation, a.CreateNFSExportPolicy)
addTool(server, "update_nfs_export_policies", descriptions.UpdateNFSExportPolicy, updateAnnotation, a.UpdateNFSExportPolicy)
addTool(server, "delete_nfs_export_policies", descriptions.DeleteNFSExportPolicy, deleteAnnotation, a.DeleteNFSExportPolicy)
}
addTool(a, server, "list_nfs_export_policies", descriptions.ListNFSExportPolicy, readOnlyAnnotation, a.ListNFSExportPolicies)
addTool(a, server, "create_nfs_export_policies", descriptions.CreateNFSExportPolicy, createAnnotation, a.CreateNFSExportPolicy)
addTool(a, server, "update_nfs_export_policies", descriptions.UpdateNFSExportPolicy, updateAnnotation, a.UpdateNFSExportPolicy)
addTool(a, server, "delete_nfs_export_policies", descriptions.DeleteNFSExportPolicy, deleteAnnotation, a.DeleteNFSExportPolicy)

// operation on NFS Export Policy rules object
if !a.options.ReadOnly {
addTool(server, "create_nfs_export_policies_rules", descriptions.CreateNFSExportPolicyRules, createAnnotation, a.CreateNFSExportPoliciesRule)
addTool(server, "update_nfs_export_policies_rules", descriptions.UpdateNFSExportPolicyRules, updateAnnotation, a.UpdateNFSExportPoliciesRule)
addTool(server, "delete_nfs_export_policies_rules", descriptions.DeleteNFSExportPolicyRules, deleteAnnotation, a.DeleteNFSExportPoliciesRule)
}
addTool(a, server, "create_nfs_export_policies_rules", descriptions.CreateNFSExportPolicyRules, createAnnotation, a.CreateNFSExportPoliciesRule)
addTool(a, server, "update_nfs_export_policies_rules", descriptions.UpdateNFSExportPolicyRules, updateAnnotation, a.UpdateNFSExportPoliciesRule)
addTool(a, server, "delete_nfs_export_policies_rules", descriptions.DeleteNFSExportPolicyRules, deleteAnnotation, a.DeleteNFSExportPoliciesRule)

// operation on CIFS share object
addTool(server, "list_cifs_share", descriptions.ListCIFSShare, readOnlyAnnotation, a.ListCIFSShare)
if !a.options.ReadOnly {
addTool(server, "create_cifs_share", descriptions.CreateCIFSShare, createAnnotation, a.CreateCIFSShare)
addTool(server, "update_cifs_share", descriptions.UpdateCIFSShare, updateAnnotation, a.UpdateCIFSShare)
addTool(server, "delete_cifs_share", descriptions.DeleteCIFSShare, deleteAnnotation, a.DeleteCIFSShare)
}
addTool(a, server, "list_cifs_share", descriptions.ListCIFSShare, readOnlyAnnotation, a.ListCIFSShare)
addTool(a, server, "create_cifs_share", descriptions.CreateCIFSShare, createAnnotation, a.CreateCIFSShare)
addTool(a, server, "update_cifs_share", descriptions.UpdateCIFSShare, updateAnnotation, a.UpdateCIFSShare)
addTool(a, server, "delete_cifs_share", descriptions.DeleteCIFSShare, deleteAnnotation, a.DeleteCIFSShare)

return server
}
Expand Down Expand Up @@ -446,27 +434,31 @@ type ListClusterParams struct{}
type ListVolumeParams struct{}

var (
readOnlyAnnotation = &mcp.ToolAnnotations{
readOnlyAnnotation = mcp.ToolAnnotations{
ReadOnlyHint: true,
}
createAnnotation = &mcp.ToolAnnotations{
createAnnotation = mcp.ToolAnnotations{
DestructiveHint: new(false),
}
updateAnnotation = &mcp.ToolAnnotations{
updateAnnotation = mcp.ToolAnnotations{
DestructiveHint: new(true),
IdempotentHint: true,
}
deleteAnnotation = &mcp.ToolAnnotations{
deleteAnnotation = mcp.ToolAnnotations{
DestructiveHint: new(true),
IdempotentHint: true,
}
)

func addTool[In, Out any](server *mcp.Server, name string, description string, annotations *mcp.ToolAnnotations, handler mcp.ToolHandlerFor[In, Out]) {
func addTool[In, Out any](a *App, server *mcp.Server, name string, description string, annotations mcp.ToolAnnotations, handler mcp.ToolHandlerFor[In, Out]) {
if a.options.ReadOnly && annotations != readOnlyAnnotation {
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Struct comparison with pointer fields is fragile. While this works because package-level annotation variables are used consistently, it compares pointer addresses rather than values. A more robust approach would be to check the annotation fields directly (e.g., checking if ReadOnlyHint is true) or add a method to ToolAnnotations to determine if it's read-only. This would make the intent clearer and prevent issues if annotations are created differently in the future.

Suggested change
if a.options.ReadOnly && annotations != readOnlyAnnotation {
if a.options.ReadOnly && !annotations.ReadOnlyHint {

Copilot uses AI. Check for mistakes.
a.logger.Warn("skipping registration of destructive tool in read-only mode", slog.String("tool", name))
return
}
mcp.AddTool(server, &mcp.Tool{
Name: name,
Description: description,
Annotations: annotations,
Annotations: &annotations,
}, handler)
}

Expand Down
Loading