Skip to content

docs: MCP guide updates for current tool surface [sc-17040] - #1455

Merged
emmavdh merged 2 commits into
mainfrom
emma/sc-17040-documentation-mcp-updates
Jul 30, 2026
Merged

docs: MCP guide updates for current tool surface [sc-17040]#1455
emmavdh merged 2 commits into
mainfrom
emma/sc-17040-documentation-mcp-updates

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

What and why?

Updates the ValidMind MCP documentation to match the shipped backend/mcp tool surface (17 tools on origin/main), and reconciles supported-client wording across related pages.

Before

  • Capabilities covered only list/get + custom-field updates + templates
  • Filters incorrectly mentioned risk level and deployment region
  • Integrations overview / FAQ listed Claude Desktop instead of Claude Code
  • No limitations, multi-environment URL note, or create/summarize/schema coverage

After

  • Capabilities cover record/artifact read+write (including create and summarize), schemas/lookups, custom field schema + value read/write, and templates
  • Filters match the MCP record/artifact filter surface (tiering, ownership roles, status, use case, business unit, etc.)
  • Supported clients aligned to Cursor IDE + Claude Code
  • Limitations callout for inventory/templates scope, findings-only artifacts, and rate limiting
  • Production MCP URL called out explicitly, with a note for other environments

Shortcut: https://app.shortcut.com/validmind/story/17040

Implementation evidence (authoritative tool surface):

  • validmind/backend mcp/mcp_service/tool_ids.py and mcp/mcp_service/tooling.py on origin/main
  • Notable related backend work includes multi-record-type MCP support (SC-16816 / backend #3281) and earlier MCP inventory write/read expansions

How to test

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/mcp/connect-ai-assistants-via-mcp.qmd \
  guide/integrations/managing-integrations.qmd \
  faq/faq-integrations.qmd \
  guide/chatbot-capabilities.qmd \
  about/glossary/glossary.qmd

Hosted preview in docs-staging - will be available once the validate check completes:

What needs special review?

  • Auth: Customer docs continue to document API key + secret as the supported production setup path. OAuth / PAT bearer modes exist in the MCP service and eng README, but are not published here as a customer setup path.
  • Clients: Claude Desktop was removed from integrations/FAQ so those pages match the setup guide (Cursor + Claude Code). Codex appears in the eng README only and is intentionally omitted from customer docs.
  • Artifacts: Documented as findings-only, matching the current artifact_type enum.

Dependencies, breaking changes, and deployment notes

  • No product/code dependencies
  • Docs-only change; follows normal main → staging → prod documentation delivery

Release notes

Expanded the ValidMind MCP setup guide so AI assistants can create and update inventory records and findings, discover schemas and lookups, and use accurate filters — plus clarified supported clients and current limitations. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

Expand capabilities, fix filter claims, reconcile supported clients, and document limitations against the shipped ValidMind MCP server.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh emmavdh added the documentation Improvements or additions to documentation label Jul 30, 2026
Rename Chatbot capabilities, enable search, and add it beside the MCP guide in the Guides sidebar.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh
emmavdh requested review from cachafla, hunner and nibalizer July 30, 2026 21:05
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@cachafla cachafla left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great

@emmavdh
emmavdh added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit 01b7f1c Jul 30, 2026
6 of 7 checks passed
@emmavdh
emmavdh deleted the emma/sc-17040-documentation-mcp-updates branch July 30, 2026 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants