refactor: streamline mcpDescription format across all components and plugins

Copilot · purocean · Copilot · commit dc92ce998e0a · 2026-01-26T04:56:52.000Z
Co-authored-by: purocean &lt;7115690+purocean@users.noreply.github.com&gt;
diff --git a/src/renderer/components/ControlCenter.vue b/src/renderer/components/ControlCenter.vue
@@ -46,7 +46,7 @@ registerAction({
   description: t('command-desc.control-center_toggle'),
   forUser: true,
   forMcp: true,
-  mcpDescription: 'Toggle control center. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle control center. Args: [visible:boolean?]. No return.',
   handler: toggle,
   keys: [Alt, 'c']
 })
diff --git a/src/renderer/components/DefaultPreviewerRender.ce.vue b/src/renderer/components/DefaultPreviewerRender.ce.vue
@@ -265,7 +265,7 @@ onMounted(() => {
     keys: [CtrlCmd, 'r'],
     forUser: true,
     forMcp: true,
-    mcpDescription: 'Refresh preview. No args.'
+    mcpDescription: 'Refresh preview. No args. No return.'
   })
 
   registerHook('SETTING_CHANGED', updateMarkdownBodyMaxWidth)
diff --git a/src/renderer/components/DocHistory.vue b/src/renderer/components/DocHistory.vue
@@ -381,7 +381,7 @@ onMounted(() => {
     keys: [Alt, 'h'],
     forUser: true,
     forMcp: true,
-    mcpDescription: 'Show document history panel. No args.',
+    mcpDescription: 'Show document history panel. No args. No return.',
     description: t('command-desc.doc_show-history'),
   })
   registerAction({ name: 'doc.hide-history', handler: hide })
diff --git a/src/renderer/components/Editor.vue b/src/renderer/components/Editor.vue
@@ -105,7 +105,7 @@ onMounted(() => {
     description: t('command-desc.editor_rotate-custom-editors'),
     forUser: true,
     forMcp: true,
-    mcpDescription: 'Rotate through available custom editors. No args.',
+    mcpDescription: 'Rotate through custom editors. No args. No return.',
     handler: () => {
       if (availableEditors.value.length > 1) {
         const index = availableEditors.value.findIndex(x => x.name === store.state.editor)
diff --git a/src/renderer/components/ExtensionManager.vue b/src/renderer/components/ExtensionManager.vue
@@ -675,7 +675,7 @@ onMounted(() => {
     handler: show,
     forUser: true,
     forMcp: true,
-    mcpDescription: 'Show extension manager. No args.',
+    mcpDescription: 'Show extension manager. No args. No return.',
   })
 })
 
diff --git a/src/renderer/components/FileTabs.vue b/src/renderer/components/FileTabs.vue
@@ -235,7 +235,7 @@ export default defineComponent({
         keys: [CtrlCmd, Alt, 'ArrowLeft'],
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Switch to left tab. No args.',
+        mcpDescription: 'Switch to left tab. No args. No return.',
         handler () {
           const prev = findTab(-1)
           prev && switchTab(prev)
@@ -247,7 +247,7 @@ export default defineComponent({
         description: t('command-desc.file-tabs_switch-right'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Switch to right tab. No args.',
+        mcpDescription: 'Switch to right tab. No args. No return.',
         handler () {
           const next = findTab(1)
           next && switchTab(next)
@@ -261,7 +261,7 @@ export default defineComponent({
         handler: closeCurrent,
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Close current tab. No args.',
+        mcpDescription: 'Close current tab. No args. No return.',
         keys: isElectron ? [CtrlCmd, 'w'] : [CtrlCmd, Alt, 'w']
       })
 
@@ -270,7 +270,7 @@ export default defineComponent({
         description: t('command-desc.file-tabs_search-tabs'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Search tabs. No args.',
+        mcpDescription: 'Search tabs. No args. No return.',
         handler () {
           refTabs.value?.showQuickFilter()
         },
@@ -282,7 +282,7 @@ export default defineComponent({
         description: t('command-desc.file-tabs_show-welcome'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Show welcome page. No args.',
+        mcpDescription: 'Show welcome page. No args. No return.',
         handler () {
           switchDoc(null)
         },
diff --git a/src/renderer/components/Filter.vue b/src/renderer/components/Filter.vue
@@ -106,7 +106,7 @@ export default defineComponent({
         handler: showQuickOpen,
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Show quick open dialog. No args.',
+        mcpDescription: 'Show quick open dialog. No args. No return.',
         keys: [CtrlCmd, 'p']
       })
       registerAction({ name: 'filter.choose-document', handler: chooseDocument })
diff --git a/src/renderer/components/FindInPreview.vue b/src/renderer/components/FindInPreview.vue
@@ -201,7 +201,7 @@ registerAction({
   handler: show,
   forUser: true,
   forMcp: true,
-  mcpDescription: 'Show find widget in preview. No args.',
+  mcpDescription: 'Show find widget in preview. No args. No return.',
   when: () => {
     return !(getEditor()?.hasTextFocus()) && store.state.showView
   }
diff --git a/src/renderer/components/KeyboardShortcuts.vue b/src/renderer/components/KeyboardShortcuts.vue
@@ -371,7 +371,7 @@ registerAction({
   handler: show,
   forUser: true,
   forMcp: true,
-  mcpDescription: 'Show keyboard shortcuts manager. No args.'
+  mcpDescription: 'Show keyboard shortcuts manager. No args. No return.'
 })
 
 onUnmounted(() => {
diff --git a/src/renderer/components/SearchPanel.vue b/src/renderer/components/SearchPanel.vue
@@ -787,7 +787,7 @@ registerAction({
   description: t('command-desc.base_find-in-repository'),
   forUser: true,
   forMcp: true,
-  mcpDescription: 'Find text in repository. Optional args: [query:FindInRepositoryQuery] - search query object.',
+  mcpDescription: 'Find text in repository. Args: [query:FindInRepositoryQuery?]. No return.',
   handler: (query?: FindInRepositoryQuery) => {
     visible.value = true
 
diff --git a/src/renderer/components/Tree.vue b/src/renderer/components/Tree.vue
@@ -97,7 +97,7 @@ export default defineComponent({
       description: t('command-desc.tree_reveal-current-node'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Reveal current document in tree. No args.',
+      mcpDescription: 'Reveal current document in tree. No args. No return.',
       handler: revealCurrentNode
     })
 
diff --git a/src/renderer/plugins/copy-content.tsx b/src/renderer/plugins/copy-content.tsx
@@ -143,7 +143,7 @@ export default {
       handler: copyContent,
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Copy content in various formats. No args.',
+      mcpDescription: 'Copy content in various formats. No args. No return.',
       keys: [ctx.keybinding.CtrlCmd, ctx.keybinding.Shift, 'c'],
     })
 
diff --git a/src/renderer/plugins/editor-markdown.ts b/src/renderer/plugins/editor-markdown.ts
@@ -193,7 +193,7 @@ export default {
       handler: focusEditor,
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Focus editor. No args.',
+      mcpDescription: 'Focus editor. No args. No return.',
       keys: [ctx.keybinding.Shift, ctx.keybinding.Alt, 'x']
     })
   }
diff --git a/src/renderer/plugins/electron-zoom.ts b/src/renderer/plugins/electron-zoom.ts
@@ -35,7 +35,7 @@ export default {
         description: ctx.i18n.t('command-desc.plugin_electron-zoom_zoom-in'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Zoom in. No args.',
+        mcpDescription: 'Zoom in. No args. No return.',
         handler: () => changeZoomFactor(true)
       })
 
@@ -45,7 +45,7 @@ export default {
         description: ctx.i18n.t('command-desc.plugin_electron-zoom_zoom-out'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Zoom out. No args.',
+        mcpDescription: 'Zoom out. No args. No return.',
         handler: () => changeZoomFactor(false)
       })
 
@@ -55,7 +55,7 @@ export default {
         description: ctx.i18n.t('command-desc.plugin_electron-zoom_zoom-reset'),
         forUser: true,
         forMcp: true,
-        mcpDescription: 'Reset zoom. No args.',
+        mcpDescription: 'Reset zoom. No args. No return.',
         handler: () => setZoomFactor(1)
       })
 
diff --git a/src/renderer/plugins/history-stack.ts b/src/renderer/plugins/history-stack.ts
@@ -142,7 +142,7 @@ export default {
       description: ctx.i18n.t('command-desc.plugin_document-history-stack_back'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Go back in document history. No args.',
+      mcpDescription: 'Go back in document history. No args. No return.',
       handler: () => go(-1),
       keys: [ctx.keybinding.Alt, ctx.keybinding.BracketLeft],
     })
@@ -152,7 +152,7 @@ export default {
       description: ctx.i18n.t('command-desc.plugin_document-history-stack_forward'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Go forward in document history. No args.',
+      mcpDescription: 'Go forward in document history. No args. No return.',
       handler: () => go(1),
       keys: [ctx.keybinding.Alt, ctx.keybinding.BracketRight],
     })
diff --git a/src/renderer/plugins/image-localization.ts b/src/renderer/plugins/image-localization.ts
@@ -108,7 +108,7 @@ export default {
       description: ctx.i18n.t('command-desc.plugin_image-localization_all'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Transform all remote images to local. No args.',
+      mcpDescription: 'Transform remote images to local. No args. No return.',
       when,
     })
 
diff --git a/src/renderer/plugins/insert-table/index.ts b/src/renderer/plugins/insert-table/index.ts
@@ -112,7 +112,7 @@ export default {
       name: actionName,
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Insert table. No args.',
+      mcpDescription: 'Insert table. No args. No return.',
       description: ctx.i18n.t('insert-table.insert-table'),
       handler: () => {
         if (canInsertTable()) {
diff --git a/src/renderer/plugins/status-bar-premium.ts b/src/renderer/plugins/status-bar-premium.ts
@@ -84,7 +84,7 @@ export default {
       description: ctx.i18n.t('premium.confetti'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Show confetti celebration. No args.',
+      mcpDescription: 'Show confetti celebration. No args. No return.',
       handler
     })
   }
diff --git a/src/renderer/plugins/status-bar-repository-switch.ts b/src/renderer/plugins/status-bar-repository-switch.ts
@@ -79,7 +79,7 @@ export default {
         description: i === 0 ? ctx.i18n.t('switch-the-last-repo') : ctx.i18n.t('switch-repo-n', String(i)),
         forUser: true,
         forMcp: true,
-        mcpDescription: `Switch to repository ${i === 0 ? 'last' : i}. No args.`,
+        mcpDescription: `Switch to repository ${i === 0 ? 'last' : i}. No args. No return.`,
         keys: [ctx.keybinding.Alt, String(i)],
         handler: () => {
           const repos = ctx.repo.getAllRepos()
diff --git a/src/renderer/plugins/status-bar-theme.ts b/src/renderer/plugins/status-bar-theme.ts
@@ -51,7 +51,7 @@ export default {
       description: ctx.i18n.t('command-desc.plugin_status-bar-theme_switch'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Switch theme. No args.',
+      mcpDescription: 'Switch theme. No args. No return.',
     })
   }
 } as Plugin
diff --git a/src/renderer/plugins/switch-todo.ts b/src/renderer/plugins/switch-todo.ts
@@ -34,7 +34,7 @@ export default {
       keys: [ctx.keybinding.Alt, 'o'],
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Switch todo status. Optional args: [line:number, checked:boolean] - line number and checked state.',
+      mcpDescription: 'Switch todo status. Args: [line:number?, checked:boolean?]. No return.',
       handler: (line?: number, checked?: boolean) => {
         if (line) {
           switchTodo(line, checked)
diff --git a/src/renderer/plugins/text-comparator.ts b/src/renderer/plugins/text-comparator.ts
@@ -50,7 +50,7 @@ export default {
       description: ctx.i18n.t('status-bar.tool.open-text-comparator'),
       forUser: true,
       forMcp: true,
-      mcpDescription: 'Open text comparator. Optional args: [original:Doc, modified:Doc] - documents to compare.',
+      mcpDescription: 'Open text comparator. Args: [original:Doc?, modified:Doc?]. No return.',
       handler: (original?: Doc | null, modified?: Doc | null) => {
         type Extra = {
           original?: Doc | null
diff --git a/src/renderer/plugins/view-links/index.ts b/src/renderer/plugins/view-links/index.ts
@@ -40,7 +40,7 @@ export default {
       name: actionName,
       forUser: true,
       forMcp: true,
-      mcpDescription: 'View document links. No args.',
+      mcpDescription: 'View document links. No args. No return.',
       description: ctx.i18n.t('command-desc.plugin_view-links_view-document-links'),
       handler: showLinks,
       when,
diff --git a/src/renderer/services/editor.ts b/src/renderer/services/editor.ts
@@ -579,7 +579,7 @@ export async function isDirty (): Promise<boolean> {
 registerAction({
   name: 'editor.toggle-wrap',
   description: t('command-desc.editor_toggle-wrap'),
-  mcpDescription: 'Toggle word wrap in editor. No args - toggles wrap state.',
+  mcpDescription: 'Toggle word wrap. No args. No return.',
   handler: toggleWrap,
   forUser: true,
   forMcp: true,
diff --git a/src/renderer/services/layout.ts b/src/renderer/services/layout.ts
@@ -117,7 +117,7 @@ export function toggleEditorPreviewExclusive (exclusive?: boolean) {
 registerAction({
   name: 'layout.toggle-side',
   description: t('command-desc.layout_toggle-side'),
-  mcpDescription: 'Toggle side panel visibility. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle side panel. Args: [visible:boolean?]. No return.',
   handler: toggleSide,
   forUser: true,
   forMcp: true,
@@ -127,7 +127,7 @@ registerAction({
 registerAction({
   name: 'layout.toggle-editor',
   description: t('command-desc.layout_toggle-editor'),
-  mcpDescription: 'Toggle editor panel visibility. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle editor panel. Args: [visible:boolean?]. No return.',
   handler: toggleEditor,
   forUser: true,
   forMcp: true,
@@ -137,7 +137,7 @@ registerAction({
 registerAction({
   name: 'layout.toggle-view',
   description: t('command-desc.layout_toggle-view'),
-  mcpDescription: 'Toggle preview panel visibility. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle preview panel. Args: [visible:boolean?]. No return.',
   handler: toggleView,
   forUser: true,
   forMcp: true,
@@ -147,7 +147,7 @@ registerAction({
 registerAction({
   name: 'layout.toggle-xterm',
   description: t('command-desc.layout_toggle-xterm'),
-  mcpDescription: 'Toggle terminal panel visibility. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle terminal panel. Args: [visible:boolean?]. No return.',
   handler: toggleXterm,
   forUser: true,
   forMcp: true,
diff --git a/src/renderer/services/tree.ts b/src/renderer/services/tree.ts
@@ -100,7 +100,7 @@ store.watch(() => store.state.treeSort, async () => {
 registerAction({
   name: 'tree.refresh',
   description: t('command-desc.tree_refresh'),
-  mcpDescription: 'Refresh file tree. No args - refreshes current repository tree.',
+  mcpDescription: 'Refresh file tree. No args. No return.',
   forUser: true,
   forMcp: true,
   handler: refreshTree,
diff --git a/src/renderer/services/view.ts b/src/renderer/services/view.ts
@@ -544,7 +544,7 @@ registerAction({
   forUser: true,
   forMcp: true,
   description: t('command-desc.view_enter-presentation'),
-  mcpDescription: 'Enter presentation mode. No args - enters presentation mode.',
+  mcpDescription: 'Enter presentation mode. No args. No return.',
   handler: () => present(true),
   keys: ['F5']
 })
diff --git a/src/renderer/services/workbench.ts b/src/renderer/services/workbench.ts
@@ -18,7 +18,7 @@ export function toggleOutline (visible?: boolean) {
 registerAction({
   name: 'workbench.toggle-outline',
   description: t('command-desc.workbench_toggle-outline'),
-  mcpDescription: 'Toggle outline panel visibility. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle outline panel. Args: [visible:boolean?]. No return.',
   forUser: true,
   forMcp: true,
   handler: toggleOutline,
diff --git a/src/renderer/startup.ts b/src/renderer/startup.ts
@@ -299,7 +299,7 @@ registerHook('RIGHT_SIDE_PANEL_CHANGE', ({ type }) => {
 registerAction({
   name: 'layout.toggle-content-right-side',
   description: t('command-desc.layout_toggle-content-right-side'),
-  mcpDescription: 'Toggle content right side panel. Optional args: [visible:boolean] - true to show, false to hide, omit to toggle.',
+  mcpDescription: 'Toggle content right panel. Args: [visible:boolean?]. No return.',
   handler: ctx.layout.toggleContentRightSide,
   forUser: true,
   forMcp: true,

Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ registerAction({`
`201`	`201`	`handler: show,`
`202`	`202`	`forUser: true,`
`203`	`203`	`forMcp: true,`
`204`		`- mcpDescription: 'Show find widget in preview. No args.',`
	`204`	`+ mcpDescription: 'Show find widget in preview. No args. No return.',`
`205`	`205`	`when: () => {`
`206`	`206`	`return !(getEditor()?.hasTextFocus()) && store.state.showView`
`207`	`207`	`}`