Skip to content

docs: add MCP (Model Context Protocol) documentationΒ #1450

@meylis1998

Description

@meylis1998

Description

The CLI has MCP support implemented at /lib/src/mcp/ with 4 tools exposed (create, test, packages_get, packages_check_licenses), but it's not documented anywhere. Users cannot discover or use this feature without prior knowledge.

Motivation

As noted in #1356, MCP integration allows very_good_cli to work seamlessly with AI-assisted developer environments (Claude Desktop, Cursor, GitHub Copilot, etc.). However, the feature is currently hidden.

Proposed Changes

1. Update README.md

Add a new "Model Context Protocol (MCP)" section:

  • Brief explanation of MCP support
  • Link to detailed documentation
  • Quick start example

2. Create /docs/mcp.md

Comprehensive guide including:

  • What is MCP? - Brief overview and benefits
  • Getting Started - How to start the server (very_good mcp)
  • Client Configuration - Examples for popular clients:
    • Claude Desktop (.claude_desktop_config.json)
    • Cursor (.cursor/mcp.json)
    • GitHub Copilot
    • VS Code Copilot
    • Windsurf
  • Available Tools - Complete reference for all 4 tools:
    • Tool name, description, parameters, examples
  • Use Cases - Practical examples showing AI-assisted workflows
  • Troubleshooting - Common issues and solutions
  • Experimental Status - Note that MCP support is experimental

3. Add to CHANGELOG.md

Document the MCP feature when released.

Configuration Examples

Claude Desktop:

{
  "mcpServers": {
    "very_good_cli": {
      "command": "very_good",
      "args": ["mcp"]
    }
  }
}

Cursor:

{
  "mcpServers": {
    "very_good_cli": {
      "command": "very_good",
      "args": ["mcp"]
    }
  }
}

Related

Additional Context

This should be completed before or alongside the experimental MCP release to ensure users can discover and use the feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Needs Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions