Skip to content

feat(mcp): rewrite tool descriptions for agent consumption - #848

Merged
ariskemper merged 8 commits into
mainfrom
feat/mcp-tool-descriptions
Apr 7, 2026
Merged

feat(mcp): rewrite tool descriptions for agent consumption#848
ariskemper merged 8 commits into
mainfrom
feat/mcp-tool-descriptions

Conversation

@ariskemper

@ariskemper ariskemper commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite all ~25 in-scope MCP tool descriptions to use "Use this when..." pattern with negative cases ("Do not use for...")
  • Add concrete examples to all Zod .describe() parameter annotations (e.g., Example: 'compile'. Omit to return all types.)
  • Add return value shape info to every tool description (e.g., "Returns an array of route info with path, type, and file")
  • Fix inaccurate descriptions flagged in review: vf_get_status (always reports running=true), vf_hot_reload (no-op stub), vf_get_debug_context (actual return fields)
  • Add safety warnings: issues_delete (irreversible), vf_scaffold (may overwrite), vf_preview_route (API side effects)
  • Restore lost issues_create prefix semantics (TASK/PLAN/ISSUE guidance)
  • Description-only changes — no logic modifications

Closes #835

Out of scope

Test plan

  • All in-scope descriptions follow "Use this when... Do not use for..." pattern
  • All in-scope descriptions mention return value shape
  • All Zod parameters have .describe() with examples and defaults
  • No two tools have ambiguously similar descriptions
  • deno fmt passes
  • deno lint passes
  • Type check passes
  • Unit tests pass (1291 passed, 0 failed)
  • Build succeeds

@ariskemper
ariskemper marked this pull request as ready for review April 7, 2026 07:44
@ariskemper
ariskemper marked this pull request as draft April 7, 2026 07:44

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fdf5a0a392

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread cli/mcp/tools.ts Outdated
Comment thread cli/mcp/tools/dev-tools.ts Outdated
Fix inaccurate debug context description, restore lost issue prefix
semantics, strengthen delete warning, add side-effect and overwrite
warnings, and resolve circular HMR/hot-reload guidance.
vf_get_status: clarify it always reports running=true, not a real health check
vf_hot_reload: clarify it is a no-op stub, point to vf_trigger_hmr for actual HMR
vf_trigger_hmr: remove misleading cross-reference to no-op vf_hot_reload
Keep our updated descriptions while incorporating title, annotations,
and other structural additions from main.
vf_list_routes: include error, loading, and not-found in route types listed
vf_list_integrations: cross-reference vf_create_project instead of vf_list_templates
…l descriptions

Ensures every in-scope tool description mentions return value shape
and has a negative case cross-reference, per acceptance criteria.
@ariskemper
ariskemper marked this pull request as ready for review April 7, 2026 10:03

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7b1d143fe7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread cli/mcp/tools/dev-tools.ts Outdated
Narrow the "Do not use" guidance to error counts/uptime instead of
"current status", since vf_get_status does not probe reachability.
@ariskemper
ariskemper enabled auto-merge (squash) April 7, 2026 10:19
@ariskemper
ariskemper merged commit 9280751 into main Apr 7, 2026
17 checks passed
@ariskemper
ariskemper deleted the feat/mcp-tool-descriptions branch April 7, 2026 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(mcp): rewrite tool descriptions for agent consumption

1 participant