Skip to content

Documentation for ValidMind MCP#1221

Open
nrichers wants to merge 7 commits intomainfrom
nrichers/sc-13661/documentation-for-validmind-mcp
Open

Documentation for ValidMind MCP#1221
nrichers wants to merge 7 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
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request enhances the documentation by introducing a comprehensive set of pages and glossary entries for the Model Context Protocol (MCP). The updates include:

  • New glossary pages (_mcp.qmd, _mcp-server.qmd, _mcp-tool.qmd) that explain the MCP server, tool, and the overall MCP standard in clear terms.
  • Updates to the sidebar configuration to add a link for the new "Connect AI assistants via MCP" guide, ensuring that users can easily access the new documentation.
  • Modifications to the "managing-integrations.qmd" page by incorporating a new AI assistants section, complete with a mermaid diagram that illustrates the interaction between AI assistants, the MCP server, and the ValidMind platform.
  • The newly added guide (connect-ai-assistants-via-mcp.qmd) provides detailed instructions for configuring AI assistants (such as Cursor IDE and Claude Code) to integrate with the ValidMind MCP server. The guide covers prerequisites, key concepts, configuration steps, and troubleshooting tips.

These changes aim to improve user guidance on how to integrate AI assistants via the MCP protocol, making it easier to query and manage model inventories through natural language interactions.

Test Suggestions

  • Verify that the new glossary pages render correctly and that their content is accurately included where referenced.
  • Ensure the new sidebar entries and navigation links work properly, especially the link to the 'Connect AI assistants via MCP' guide.
  • Render the updated 'managing-integrations.qmd' page to check that the new AI assistants section and mermaid diagram display as expected.
  • Test the configuration examples provided in the MCP guide for Cursor IDE and Claude Code to ensure they are clear and functional.
  • Perform a user flow test to simulate troubleshooting scenarios, such as connection errors or authentication issues, ensuring the documentation provides adequate guidance.

@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.

1 participant