Skip to content

Documentation for ValidMind MCP#1221

Merged
nrichers merged 8 commits intomainfrom
nrichers/sc-13661/documentation-for-validmind-mcp
Mar 31, 2026
Merged

Documentation for ValidMind MCP#1221
nrichers merged 8 commits intomainfrom
nrichers/sc-13661/documentation-for-validmind-mcp

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Mar 13, 2026

Pull Request Description

What and why?

Adds documentation for the ValidMind MCP server, enabling users to connect AI assistants like Cursor IDE and Claude Code to query and manage their model inventory through natural language.

New files created:

  • site/guide/mcp/connect-ai-assistants-via-mcp.qmd — Main documentation page with prerequisites, key concepts, configuration instructions, and troubleshooting
  • site/guide/mcp/_mcp-intro.qmd — Brief intro include
  • site/about/glossary/mcp/_mcp.qmd — MCP glossary definition
  • site/about/glossary/mcp/_mcp-server.qmd — MCP server glossary definition
  • site/about/glossary/mcp/_mcp-tool.qmd — MCP tool glossary definition

Files updated:

  • site/guide/_sidebar.yaml — Added MCP page under Integrations
  • site/guide/integrations/managing-integrations.qmd — Added AI assistants section with cross-reference to MCP docs

Documentation covers:

  • What MCP is and how ValidMind MCP works (with mermaid diagram)
  • Supported operations: model/artifact list and get, custom field list and value updates, template operations
  • Configuration for Cursor IDE and Claude Code
  • Troubleshooting common issues

Addresses sc-13661.

How to test

Check the live preview: Connect AI assistants via MCP

Proof the instructions work

Cursor

Capto_ 2026-03-27_03-10-12_pm2 Capto_ 2026-03-27_02-48-22_pm2 Capto_ 2026-03-27_02-48-49_pm2 Capto_ 2026-03-27_02-49-25_pm

Claude Code

Capto_ 2026-03-27_03-10-12_pm2 Capto_ 2026-03-27_03-15-30_pm2 Capto_ 2026-03-27_03-15-13_pm image

Also verify:

What needs special review?

Dependencies, breaking changes, and deployment notes

None — this is new documentation.

Release notes

Added documentation for the ValidMind MCP server, which enables AI assistants like Claude Desktop and Cursor to query and manage your model inventory through natural language. Learn more

Checklist

  • What and why
  • How to test
  • PR linked to Shortcut
  • Tested locally

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added the internal Not to be externalized in the release notes label Mar 13, 2026
@nrichers nrichers requested a review from hunner March 27, 2026 22:33
@github-actions
Copy link
Copy Markdown
Contributor

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 7c8b83a

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.69 1.00 0.82
/get-started/get-started.html 0.85 0.71 1.00 0.73
/guide/guides.html 0.81 0.69 1.00 0.82
/index.html 0.93 0.65 1.00 0.82
/releases/all-releases.html 0.86 0.69 1.00 0.73
/support/support.html 0.91 0.68 1.00 0.82
/training/training.html 0.85 0.63 0.96 0.73

@nrichers nrichers force-pushed the nrichers/sc-13661/documentation-for-validmind-mcp branch from 444ede6 to 4722c3c Compare March 28, 2026 00:10
Copy link
Copy Markdown

@hunner hunner left a comment

Choose a reason for hiding this comment

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

Oh my goodness, this is wonderful! Just exactly what we needed, and very clearly put :)

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request introduces comprehensive documentation for the Model Context Protocol (MCP) integration, targeting AI assistants. New glossary entries for MCP, MCP server, and MCP tools have been added to the glossary section. In addition, the sidebar has been updated to include a link to the new MCP guide, and the managing integrations guide now includes an extended section for AI assistants. The new guide "Connect AI assistants via MCP" provides detailed instructions on how to configure and use MCP with popular AI assistants like Cursor IDE and Claude Code. The documentation features a Mermeid diagram illustrating the MCP workflow, practical configuration examples (using placeholders for API keys), and troubleshooting steps to resolve common issues such as connection and authentication errors.

Test Suggestions

  • Verify that all new links in the sidebar and managing integrations guide navigate correctly to the MCP documentation.
  • Ensure that the glossary entries for MCP, MCP server, and MCP tool are correctly rendered and display the intended content.
  • Validate the Mermaid diagram renders properly in the MCP guide.
  • Confirm that the configuration examples (JSON for Cursor IDE and bash commands for Claude Code) are correctly formatted and provide clear instructions.
  • Check that all in-document references (footnotes and links) work as expected.

@nrichers
Copy link
Copy Markdown
Collaborator Author

Oh my goodness, this is wonderful! Just exactly what we needed, and very clearly put :)

Thank you for the ValidMind MCP server! I had this moment while I was testing when interacting with ValidMind felt almost ... magical. Way cool. 🫶

@nrichers nrichers merged commit 74ab013 into main Mar 31, 2026
7 of 8 checks passed
@nrichers nrichers deleted the nrichers/sc-13661/documentation-for-validmind-mcp branch March 31, 2026 21:23
@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants