3b8ff504c0
* Add fields param to search_code and get_file_contents Add an optional `fields` array parameter to the `search_code` and `get_file_contents` tools so callers can request only the fields they need, reducing tool response size and context usage. - search_code: filters each result item to the selected fields while preserving the total_count / incomplete_results wrapper. - get_file_contents: filters each directory entry when listing a directory; ignored for single-file responses. Adds shared filterFields / filterEachField helpers and per-tool field enums, plus unit tests and regenerated toolsnaps and docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Gate fields param behind fields_param flag and add usage telemetry Register search_code and get_file_contents as two mutually exclusive variants gated by the new `fields_param` feature flag, following the existing dual-variant flag pattern: - The flag-enabled variant advertises the optional `fields` parameter and filters each result to the requested subset. It owns the `<tool>_ff_fields_param` toolsnap. - The Legacy* variant exposes the original schema with no `fields` parameter and never filters, acting as a kill switch when the flag is off. It owns the canonical toolsnap. Add best-effort, low-cardinality telemetry at each tool's filter point to measure adoption and realized savings: - `mcp.fields.tool_call` (increment) tagged by tool and whether the response was filtered. - `mcp.fields.bytes_full` / `bytes_sent` / `bytes_saved` (counters) tagged by tool, emitted only when a response was filtered. Tags are limited to `tool` and `filtered` to bound cardinality; repo, owner, user, query, and the requested field list are never tagged. The local server discards these via the noop metrics sink, while hosted deployments inject a real sink. Metrics accessors now fall back to a noop sink when no exporter is configured so emitting telemetry never panics. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Drop mcp.fields.bytes_saved metric Remove the mcp.fields.bytes_saved counter. It is derivable on the dashboard from the two remaining byte counters, since sum(bytes_full) - sum(bytes_sent) equals the total saved at any rollup, so emitting it separately is redundant. Keeping only bytes_full and bytes_sent shrinks the emitted telemetry surface. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
94 lines
3.8 KiB
Go
94 lines
3.8 KiB
Go
package github
|
|
|
|
import "slices"
|
|
|
|
// MCPAppsFeatureFlag is the feature flag name for MCP Apps (interactive UI forms).
|
|
const MCPAppsFeatureFlag = "remote_mcp_ui_apps"
|
|
|
|
// FeatureFlagCSVOutput is the feature flag name for CSV output on list tools.
|
|
const FeatureFlagCSVOutput = "csv_output"
|
|
|
|
// FeatureFlagIFCLabels is the feature flag name for IFC security labels in tool results.
|
|
const FeatureFlagIFCLabels = "ifc_labels"
|
|
|
|
// FeatureFlagFileBlame is the feature flag name for the get_file_blame tool,
|
|
// which exposes git blame information for a file. It is gated so the extra tool
|
|
// is not advertised by default, keeping the tool surface small unless opted in.
|
|
const FeatureFlagFileBlame = "file_blame"
|
|
|
|
// FeatureFlagIssueDependencies is the feature flag name for the issue dependency
|
|
// tools (issue_dependency_read / issue_dependency_write), which read and edit an
|
|
// issue's blocked-by / blocking relationships. It is gated so these tools are not
|
|
// advertised in the default surface, keeping the fixed tool-schema cost small
|
|
// unless explicitly opted in.
|
|
const FeatureFlagIssueDependencies = "issue_dependencies"
|
|
|
|
// FeatureFlagFieldsParam is the feature flag name for the optional `fields`
|
|
// parameter on selected read tools (for example search_code and
|
|
// get_file_contents). When enabled, those tools advertise `fields` and filter
|
|
// each result to the requested subset, reducing response size. It is gated so
|
|
// the feature can be rolled out gradually and disabled as a kill switch without
|
|
// a redeploy.
|
|
const FeatureFlagFieldsParam = "fields_param"
|
|
|
|
// AllowedFeatureFlags is the allowlist of feature flags that can be enabled
|
|
// by users via --features CLI flag or X-MCP-Features HTTP header.
|
|
// Only flags in this list are accepted; unknown flags are silently ignored.
|
|
// This is the single source of truth for which flags are user-controllable.
|
|
var AllowedFeatureFlags = []string{
|
|
MCPAppsFeatureFlag,
|
|
FeatureFlagCSVOutput,
|
|
FeatureFlagIFCLabels,
|
|
FeatureFlagIssuesGranular,
|
|
FeatureFlagPullRequestsGranular,
|
|
FeatureFlagFileBlame,
|
|
FeatureFlagIssueDependencies,
|
|
FeatureFlagFieldsParam,
|
|
}
|
|
|
|
// InsidersFeatureFlags is the list of feature flags that insiders mode enables.
|
|
// When insiders mode is active, all flags in this list are treated as enabled.
|
|
// This is the single source of truth for what "insiders" means in terms of
|
|
// feature flag expansion.
|
|
var InsidersFeatureFlags = []string{
|
|
MCPAppsFeatureFlag,
|
|
FeatureFlagCSVOutput,
|
|
FeatureFlagFileBlame,
|
|
FeatureFlagIssueDependencies,
|
|
}
|
|
|
|
// FeatureFlags defines runtime feature toggles that adjust tool behavior.
|
|
type FeatureFlags struct {
|
|
LockdownMode bool
|
|
}
|
|
|
|
// ResolveFeatureFlags computes the effective set of enabled feature flags by:
|
|
// 1. Taking the user-supplied flags (from --features or X-MCP-Features) and
|
|
// keeping only those present in AllowedFeatureFlags. Unknown or unsafe
|
|
// flags from request input are silently dropped here.
|
|
// 2. If insiders mode is on, unioning in every flag from InsidersFeatureFlags.
|
|
// Insiders is a server-controlled meta switch, so its expansion is NOT
|
|
// re-validated against AllowedFeatureFlags.
|
|
//
|
|
// AllowedFeatureFlags and InsidersFeatureFlags are independent sets:
|
|
// - A flag in AllowedFeatureFlags but not InsidersFeatureFlags is a regular
|
|
// opt-in flag that insiders mode does not turn on automatically.
|
|
// - A flag in InsidersFeatureFlags but not AllowedFeatureFlags is reachable
|
|
// only through insiders mode and cannot be enabled by user input.
|
|
//
|
|
// Returns a set (map) for O(1) lookup by the feature checker.
|
|
func ResolveFeatureFlags(enabledFeatures []string, insidersMode bool) map[string]bool {
|
|
effective := make(map[string]bool)
|
|
for _, f := range enabledFeatures {
|
|
if slices.Contains(AllowedFeatureFlags, f) {
|
|
effective[f] = true
|
|
}
|
|
}
|
|
if insidersMode {
|
|
for _, f := range InsidersFeatureFlags {
|
|
effective[f] = true
|
|
}
|
|
}
|
|
return effective
|
|
}
|