mcp-ref-docs

Overview

mcp-ref-docs is a configuration and management tool for centrally managing and retrieving reference documents and source code for Model Context Protocol (MCP) projects. By using a YAML configuration file (mcp_ref_docs.yaml), you can flexibly collect necessary documents and code from multiple Git repositories and local directories.

Supported Resource Types

mcp-ref-docs supports the following resource types in the configuration file:

• git: Retrieve files from remote Git repositories (supports both SSH and HTTPS URLs).
• local: Collect files from local directories within the same machine or project.
• external-yaml: Reference and merge external YAML configuration files (e.g., from a remote repository) for modular management.
• confluence: Fetch documents from Atlassian Confluence spaces or pages (supports authentication and page tree traversal).

Each resource type can use glob patterns for file selection and supports includes/excludes for fine-grained control (where applicable).

See the configuration guide for more details and advanced usage.

Features

• Supports multiple repositories and local directories
• Flexible file selection using glob patterns
• Manage resources at sub-resource level
• Extensible via external YAML configuration (git-url type)

Installation

Requires Node.js (v18 or later).

# Clone the repository
$ git clone <repository-url>
$ cd mcp-ref-docs

# Install dependencies
$ npm install

Usage

1. Create an mcp_ref_docs.yaml file in the project root and define the resources you want to retrieve.
2. Retrieve and manage resources via commands or API (details to be expanded in the future).

Example Configuration File

metadata:
  version: "1.0.0"
  description: "MCP SDK Reference Documents"
  maintainer: "MCP Team"

resources:
  - group: mcp-sdk
    type: git
    url: [email protected]:modelcontextprotocol/typescript-sdk.git
    resources:
      - name: docs
        description: "SDK Documentation"
        includes:
          - "**/*.md"
      - name: client
        description: "MCP Client Library"
        includes:
          - src/client/**/*.ts
          - src/shared/**/*.ts
        excludes:
          - "**/*.test.ts"

For detailed specifications and more examples, see docs/yaml-configuration-guide.md.

License

This project is licensed under the terms described in the LICENSE file.