@aramassa/mcp-docs-collector-cli-utils

CLI utilities for mcp-docs-collector - A command-line tool that connects to the mcp-docs-collector server to collect and generate documentation files.

Installation

npm install -g @aramassa/mcp-docs-collector-cli-utils

Or run directly with npx:

npx @aramassa/mcp-docs-collector-cli-utils --config <config-file>

Usage

mcp-docs-collector-cli-utils --config <path> [options]

Options

| Option | Description | Required | Multiple | |--------|-------------|----------|----------| | --config <path> | Path to mcp-docs-collector configuration file (YAML) | ✅ | ❌ | | --env-file <path> | Environment variable file path | ❌ | ✅ | | --git-url <url> | Git URL resource in format "repo|branch|path" | ❌ | ✅ | | --dir <path> | Output directory for generated files (default: current directory) | ❌ | ❌ | | --help, -h | Show help message | ❌ | ❌ |

Examples

Basic Usage

mcp-docs-collector-cli-utils --config .mcp-docs-collector.yaml

With Environment Variables

mcp-docs-collector-cli-utils --config .mcp-docs-collector.yaml --env-file .env

With Git URLs

mcp-docs-collector-cli-utils --config .mcp-docs-collector.yaml \
  --git-url "https://github.com/user/repo.git|main|docs"

Features

• MCP Protocol Client: Connects to mcp-docs-collector MCP server
• Remote Tool Execution: Execute documentation collection tools remotely
• File Generation: Automatically saves collected documentation as markdown files
• Multiple Data Sources: Supports various documentation sources via configuration

Configuration

The tool requires a YAML configuration file that defines documentation sources. Example:

docs:
  - type: local
    path: ./docs
    resources:
      - name: markdown-docs
        includes: ["**/*.md"]

Documentation

For detailed documentation and configuration examples, visit:

• GitHub Repository
• Full Documentation

License

ISC

Author

Aramassa