Skip to content

feat: add destructive hints, titles, and readonly hints to mcp tools #471

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
jonathannorris merged 2 commits into from
Jul 25, 2025
Merged

feat: add destructive hints, titles, and readonly hints to mcp tools #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5578ff
feat: add destructive hints, titles, and readonly hints to mcp tools
jonathannorris Jul 24, 2025
bb97941
fix: update tool descriptions
jonathannorris Jul 25, 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
15 changes: 15 additions & 0 deletions src/mcp/tools/customPropertiesTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,10 @@ export const customPropertiesToolDefinitions: Tool[] = [
name: 'list_custom_properties',
description:
'List custom properties in the current project. Include dashboard link in the response.',
annotations: {
title: 'List Custom Properties',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: CUSTOM_PROPERTY_PAGINATION_PROPERTIES,
Expand All @@ -230,6 +234,9 @@ export const customPropertiesToolDefinitions: Tool[] = [
name: 'create_custom_property',
description:
'Create a new custom property. Include dashboard link in the response.',
annotations: {
title: 'Create Custom Property',
},
inputSchema: {
type: 'object',
properties: CUSTOM_PROPERTY_COMMON_PROPERTIES,
Expand All @@ -248,6 +255,10 @@ export const customPropertiesToolDefinitions: Tool[] = [
name: 'update_custom_property',
description:
'Update an existing custom property. ⚠️ IMPORTANT: Custom property changes can affect feature flags in production environments. Always confirm with the user before updating custom properties for features that are active in production. Include dashboard link in the response.',
annotations: {
title: 'Update Custom Property',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: CUSTOM_PROPERTY_COMMON_PROPERTIES,
Expand All @@ -266,6 +277,10 @@ export const customPropertiesToolDefinitions: Tool[] = [
name: 'delete_custom_property',
description:
'Delete a custom property. ⚠️ CRITICAL: Deleting a custom property will remove it from ALL environments including production. ALWAYS confirm with the user before deleting any custom property. Include dashboard link in the response.',
annotations: {
title: 'Delete Custom Property',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down
14 changes: 14 additions & 0 deletions src/mcp/tools/environmentTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@ export const environmentToolDefinitions: Tool[] = [
name: 'list_environments',
description:
'List environments in the current project. Include dashboard link in the response.',
annotations: {
title: 'List Environments',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: ENVIRONMENT_PAGINATION_PROPERTIES,
Expand All @@ -205,6 +209,10 @@ export const environmentToolDefinitions: Tool[] = [
name: 'get_sdk_keys',
description:
'Get SDK keys for an environment. Include dashboard link in the response.',
annotations: {
title: 'Get SDK Keys',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -236,6 +244,9 @@ export const environmentToolDefinitions: Tool[] = [
name: 'create_environment',
description:
'Create a new environment. Include dashboard link in the response.',
annotations: {
title: 'Create Environment',
},
inputSchema: {
type: 'object',
properties: ENVIRONMENT_COMMON_PROPERTIES,
Expand All @@ -247,6 +258,9 @@ export const environmentToolDefinitions: Tool[] = [
name: 'update_environment',
description:
'Update an existing environment. Include dashboard link in the response.',
annotations: {
title: 'Update Environment',
},
inputSchema: {
type: 'object',
properties: ENVIRONMENT_COMMON_PROPERTIES,
Expand Down
52 changes: 51 additions & 1 deletion src/mcp/tools/featureTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'list_features',
description:
'List features in the current project. Include dashboard link in the response.',
annotations: {
title: 'List Feature Flags',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: FEATURE_PAGINATION_PROPERTIES,
Expand All @@ -311,6 +315,9 @@ export const featureToolDefinitions: Tool[] = [
name: 'create_feature',
description:
'Create a new feature flag. Include dashboard link in the response.',
annotations: {
title: 'Create Feature Flag',
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -368,6 +375,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'update_feature',
description:
'Update an existing feature flag. ⚠️ IMPORTANT: Changes to feature flags may affect production environments. Always confirm with the user before making changes to features that are active in production. Include dashboard link in the response.',
annotations: {
title: 'Update Feature Flag',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -411,6 +422,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'update_feature_status',
description:
'Update the status of an existing feature flag. ⚠️ IMPORTANT: Changes to feature status may affect production environments. Always confirm with the user before making changes to features that are active in production. Include dashboard link in the response.',
annotations: {
title: 'Update Feature Flag Status',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -437,6 +452,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'delete_feature',
description:
'Delete an existing feature flag. ⚠️ CRITICAL: Deleting a feature flag will remove it from ALL environments including production. ALWAYS confirm with the user before deleting any feature flag. Include dashboard link in the response.',
annotations: {
title: 'Delete Feature Flag',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -460,6 +479,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'fetch_feature_variations',
description:
'Get a list of variations for a feature. Include dashboard link in the response.',
annotations: {
title: 'Get Feature Variations',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -484,6 +507,9 @@ export const featureToolDefinitions: Tool[] = [
name: 'create_feature_variation',
description:
'Create a new variation within a feature. Include dashboard link in the response.',
annotations: {
title: 'Create Feature Variation',
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -511,7 +537,11 @@ export const featureToolDefinitions: Tool[] = [
{
name: 'update_feature_variation',
description:
'Update an existing variation by key. Include dashboard link in the response.',
'Update an existing variation by key. ⚠️ WARNING: Updating a feature variation may affect production environments. Include dashboard link in the response.',
Copy link

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

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

The warning message format is inconsistent with other tools. Other destructive operations use '⚠️ IMPORTANT:' while this uses '⚠️ WARNING:'. Consider using '⚠️ IMPORTANT:' for consistency.

Suggested change
'Update an existing variation by key. ⚠️ WARNING: Updating a feature variation may affect production environments. Include dashboard link in the response.',
'Update an existing variation by key. ⚠️ IMPORTANT: Updating a feature variation may affect production environments. Include dashboard link in the response.',

Copilot uses AI. Check for mistakes.
annotations: {
title: 'Update Feature Variation',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -540,6 +570,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'enable_feature_targeting',
description:
'Enable targeting for a feature in an environment. ⚠️ IMPORTANT: Always confirm with the user before making changes to production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Enable Feature Targeting',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -561,6 +595,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'disable_feature_targeting',
description:
'Disable targeting for a feature in an environment. ⚠️ IMPORTANT: Always confirm with the user before making changes to production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Disable Feature Targeting',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -582,6 +620,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'list_feature_targeting',
description:
'List feature configurations (targeting rules) for a feature. Include dashboard link in the response.',
annotations: {
title: 'List Feature Targeting Rules',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -606,6 +648,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'update_feature_targeting',
description:
'Update feature configuration (targeting rules) for a feature in an environment. ⚠️ IMPORTANT: Always confirm with the user before making changes to production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Update Feature Targeting Rules',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down Expand Up @@ -740,6 +786,10 @@ export const featureToolDefinitions: Tool[] = [
name: 'get_feature_audit_log_history',
description:
'Get timeline of feature flag changes from DevCycle audit log. Include dashboard link in the response.',
annotations: {
title: 'Get Feature Audit Log History',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down
14 changes: 14 additions & 0 deletions src/mcp/tools/projectTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ export const projectToolDefinitions: Tool[] = [
name: 'list_projects',
description:
'List all projects in the current organization. Include dashboard link in the response.',
annotations: {
title: 'List Projects',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: PROJECT_PAGINATION_PROPERTIES,
Expand All @@ -170,6 +174,10 @@ export const projectToolDefinitions: Tool[] = [
name: 'get_current_project',
description:
'Get the currently selected project. Include dashboard link in the response.',
annotations: {
title: 'Get Current Project',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {},
Expand All @@ -180,6 +188,9 @@ export const projectToolDefinitions: Tool[] = [
name: 'create_project',
description:
'Create a new project. Include dashboard link in the response.',
annotations: {
title: 'Create Project',
},
inputSchema: {
type: 'object',
properties: PROJECT_COMMON_PROPERTIES,
Expand All @@ -191,6 +202,9 @@ export const projectToolDefinitions: Tool[] = [
name: 'update_project',
description:
'Update an existing project. Include dashboard link in the response.',
annotations: {
title: 'Update Project',
},
inputSchema: {
type: 'object',
properties: PROJECT_COMMON_PROPERTIES,
Expand Down
8 changes: 8 additions & 0 deletions src/mcp/tools/resultsTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ export const resultsToolDefinitions: Tool[] = [
name: 'get_feature_total_evaluations',
description:
'Get total variable evaluations per time period for a specific feature. Include dashboard link in the response.',
annotations: {
title: 'Get Feature Total Evaluations',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: FEATURE_EVALUATION_QUERY_PROPERTIES,
Expand All @@ -128,6 +132,10 @@ export const resultsToolDefinitions: Tool[] = [
name: 'get_project_total_evaluations',
description:
'Get total variable evaluations per time period for the entire project. Include dashboard link in the response.',
annotations: {
title: 'Get Project Total Evaluations',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: PROJECT_EVALUATION_QUERY_PROPERTIES,
Expand Down
21 changes: 21 additions & 0 deletions src/mcp/tools/selfTargetingTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'get_self_targeting_identity',
description:
'Get current DevCycle identity for self-targeting. Include dashboard link in the response.',
annotations: {
title: 'Get Self-Targeting Identity',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {},
Expand All @@ -106,6 +110,9 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'update_self_targeting_identity',
description:
'Update DevCycle identity for self-targeting and overrides. Include dashboard link in the response.',
annotations: {
title: 'Update Self-Targeting Identity',
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -119,6 +126,10 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'list_self_targeting_overrides',
description:
'List all self-targeting overrides for the current project. Include dashboard link in the response.',
annotations: {
title: 'List Self-Targeting Overrides',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: {},
Expand All @@ -140,6 +151,9 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'set_self_targeting_override',
description:
'Set a self-targeting override for a feature variation. ⚠️ IMPORTANT: Always confirm with the user before setting overrides for production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Set Self-Targeting Override For Feature/Environment',
},
inputSchema: {
type: 'object',
properties: OVERRIDE_COMMON_PROPERTIES,
Expand All @@ -158,6 +172,9 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'clear_feature_self_targeting_overrides',
description:
'Clear self-targeting overrides for a specific feature/environment. ⚠️ IMPORTANT: Always confirm with the user before clearing overrides for production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Clear Self-Targeting Override For Feature/Environment',
},
inputSchema: {
type: 'object',
properties: {
Expand All @@ -179,6 +196,10 @@ export const selfTargetingToolDefinitions: Tool[] = [
name: 'clear_all_self_targeting_overrides',
description:
'Clear all self-targeting overrides for the current project. ⚠️ IMPORTANT: Always confirm with the user before clearing all overrides as it can clear production environments (environments where type = "production"). Include dashboard link in the response.',
annotations: {
title: 'Clear All Self-Targeting Overrides',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {},
Expand Down
15 changes: 15 additions & 0 deletions src/mcp/tools/variableTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,10 @@ export const variableToolDefinitions: Tool[] = [
name: 'list_variables',
description:
'List variables in the current project. Include dashboard link in the response.',
annotations: {
title: 'List Variables',
readOnlyHint: true,
},
inputSchema: {
type: 'object',
properties: VARIABLE_PAGINATION_PROPERTIES,
Expand All @@ -234,6 +238,9 @@ export const variableToolDefinitions: Tool[] = [
name: 'create_variable',
description:
'Create a new variable. Include dashboard link in the response.',
annotations: {
title: 'Create Variable',
},
inputSchema: {
type: 'object',
properties: VARIABLE_COMMON_PROPERTIES,
Expand All @@ -252,6 +259,10 @@ export const variableToolDefinitions: Tool[] = [
name: 'update_variable',
description:
'Update an existing variable. ⚠️ IMPORTANT: Variable changes can affect feature flags in production environments. Always confirm with the user before updating variables for features that are active in production. Include dashboard link in the response.',
annotations: {
title: 'Update Variable',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: UPDATE_VARIABLE_PROPERTIES,
Expand All @@ -270,6 +281,10 @@ export const variableToolDefinitions: Tool[] = [
name: 'delete_variable',
description:
'Delete a variable. ⚠️ CRITICAL: Deleting a variable will remove it from ALL environments including production. ALWAYS confirm with the user before deleting any variable. Include dashboard link in the response.',
annotations: {
title: 'Delete Variable',
destructiveHint: true,
},
inputSchema: {
type: 'object',
properties: {
Expand Down