home / mcp / vcpkg readme mcp server

Vcpkg Readme MCP Server

Provides vcpkg package READMEs, metadata, and search capabilities via MCP for AI-assisted workflows.

Installation

Add the following to your MCP client configuration file.

Configuration

{
  "mcpServers": {
    "elchika-inc-vcpkg-package-readme-mcp-server": {
      "command": "npx",
      "args": [
        "vcpkg-package-readme-mcp-server"
      ],
      "env": {
        "GITHUB_TOKEN": "YOUR_GITHUB_TOKEN"
      }
    }
  }
}

You can run this MCP server to fetch complete information about vcpkg packages, including formatted READMEs, package metadata, and advanced search results. It enables your AI assistants to surface package usage, dependencies, and maintenance details directly from the vcpkg registry with smart caching and GitHub integration for richer READMEs when applicable.

How to use

Set up a client to talk to the MCP server you run locally or remotely. Use the server as a data source for package READMEs, detailed package metadata, and searchable results. When you request a package README, you will receive formatted content with installation steps and code examples. When you request package info, you will get version history, maintainers, licenses, platform support, and dependencies. When you search, you will obtain a list of packages with descriptions and relevance scores.

How to install

Prerequisites: Node.js is recommended for running MCP-related tooling.

# Install Node.js from https://nodejs.org/
# Ensure npm is available
node -v
npm -v

Install and run the MCP server using the provided command configuration. The server starts as a local process and communicates with your MCP client via stdio.

# Start the MCP server (local stdio configuration)
npx vcpkg-package-readme-mcp-server

Configuration and usage notes

The MCP server supports reading from the vcpkg registry to retrieve package READMEs, metadata, and search results. It also integrates with GitHub to enhance READMEs when a package links to a GitHub repository. You can provide a GitHub access token to increase API rate limits.

Available tools

get_package_readme

Retrieves comprehensive README content and usage examples for vcpkg packages, including installation instructions and API documentation.

get_package_info

Fetches detailed package metadata, dependencies, and statistics from the vcpkg registry, including version info and maintainers.

search_packages

Searches the vcpkg registry with filtering by query, limit, and quality to return matching packages with descriptions and relevance scores.