Skip to content

Commit 76b9cfb

Browse files
Clarify where show_ui appears in generated docs
The code comments next to the show_ui schema entries (and the uiOnlySchemaProperties allowlist) said the property is documented in "toolsnaps / README". README is generated from the stripped (non-UI) schema, so show_ui is not actually in it — it only appears in toolsnaps and the feature-flag / insiders docs. Reword the comments to match reality. Comment-only change; no behavior or test impact. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent e54bc78 commit 76b9cfb

3 files changed

Lines changed: 15 additions & 8 deletions

File tree

pkg/github/issues.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1922,8 +1922,10 @@ Options are:
19221922
// show_ui is hidden from clients that do not advertise MCP App
19231923
// UI support. The strip happens per-request in
19241924
// inventory.ToolsForRegistration; it is present in the static
1925-
// schema (and therefore in toolsnaps / README) so the UI-capable
1926-
// surface is fully documented.
1925+
// schema (and therefore in toolsnaps and the feature-flag /
1926+
// insiders docs) so the UI-capable surface is fully
1927+
// documented. It is intentionally not in the main README,
1928+
// which renders the stripped (non-UI) schema.
19271929
"show_ui": {
19281930
Type: "boolean",
19291931
Description: "Whether to render the MCP App form instead of executing the request immediately. Defaults to true. Set to false to skip the form and execute directly — useful when you have all required values (especially ones the form does not collect, like labels, assignees, milestone, type, issue_fields, or state changes) and the user has already confirmed the action.",
@@ -2169,8 +2171,10 @@ Options are:
21692171
// show_ui is hidden from clients that do not advertise MCP App
21702172
// UI support. The strip happens per-request in
21712173
// inventory.ToolsForRegistration; it is present in the static
2172-
// schema (and therefore in toolsnaps / README) so the UI-capable
2173-
// surface is fully documented.
2174+
// schema (and therefore in toolsnaps and the feature-flag /
2175+
// insiders docs) so the UI-capable surface is fully
2176+
// documented. It is intentionally not in the main README,
2177+
// which renders the stripped (non-UI) schema.
21742178
"show_ui": {
21752179
Type: "boolean",
21762180
Description: "Whether to render the MCP App form instead of executing the request immediately. Defaults to true. Set to false to skip the form and execute directly — useful when you have all required values (especially ones the form does not collect, like labels, assignees, milestone, type, or state changes) and the user has already confirmed the action.",

pkg/github/pullrequests.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -631,8 +631,10 @@ func CreatePullRequest(t translations.TranslationHelperFunc) inventory.ServerToo
631631
// show_ui is hidden from clients that do not advertise MCP App
632632
// UI support. The strip happens per-request in
633633
// inventory.ToolsForRegistration; it is present in the static
634-
// schema (and therefore in toolsnaps / README) so the UI-capable
635-
// surface is fully documented.
634+
// schema (and therefore in toolsnaps and the feature-flag /
635+
// insiders docs) so the UI-capable surface is fully
636+
// documented. It is intentionally not in the main README,
637+
// which renders the stripped (non-UI) schema.
636638
"show_ui": {
637639
Type: "boolean",
638640
Description: "Whether to render the MCP App form instead of executing the request immediately. Defaults to true. Set to false to skip the form and execute directly — useful when you have all required values (especially ones the form does not collect, like reviewers) and the user has already confirmed the action.",

pkg/inventory/builder.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,8 +410,9 @@ func stripMCPAppsMetadata(tools []ServerTool) []ServerTool {
410410

411411
// uiOnlySchemaProperties lists input-schema property names that should only
412412
// be visible to clients that advertise MCP Apps UI support. They live on the
413-
// static schema (so toolsnaps and README document the full UI-capable
414-
// surface) and are stripped per-request when the same gate that hides
413+
// static schema (so toolsnaps and the feature-flag / insiders docs document
414+
// the full UI-capable surface; the main README renders the stripped
415+
// non-UI schema) and are stripped per-request when the same gate that hides
415416
// _meta.ui is true.
416417
var uiOnlySchemaProperties = []string{
417418
"show_ui", // explicit "render the MCP App form" toggle on form-backed write tools

0 commit comments

Comments
 (0)