MCP ExplorerExplorer

Docs To Mcp Cli

@AzureDevOpsAPIon 10 months ago
1 MIT
FreeCommunity
AI Systems
A CLI utility for turning your docs into a stdio MCP server

Overview

What is Docs To Mcp Cli

docs-to-mcp-cli is a command-line interface (CLI) tool that generates a self-contained, runnable MCP (Model Context Protocol) server to expose markdown documentation through specific tools.

Use cases

Use cases include creating a documentation server for APIs, generating help documentation for software tools, and providing contextual information for AI-driven applications.

How to use

To use docs-to-mcp-cli, install it globally via npm or use it directly with npx. The command format is: docs-to-mcp-cli --docs --packageName [–outDir

] [–toolName ].

Key features

Key features include generating an MCP server from markdown files, listing available documents, retrieving full document content, and searching through documentation.

Where to use

docs-to-mcp-cli can be used in software development, technical documentation, and any field where markdown documentation needs to be made accessible to AI assistants.

Content

docs-to-mcp-cli

A CLI tool that generates a self-contained, runnable MCP (Model Context Protocol) server that exposes markdown documentation via specific tools.

What is MCP?

The Model Context Protocol (MCP) is an open standard that enables AI assistants to access external tools and data sources. By converting your documentation to an MCP server, you allow AI assistants to:

  • Browse through your documentation
  • Search for specific information
  • Access the full content of any document
  • Use your documentation to provide more accurate and contextual responses

Installation

You can install the tool globally:

npm install -g @tiberriver256/docs-to-mcp-cli

Or use it directly with npx:

npx @tiberriver256/docs-to-mcp-cli --docs "path/to/docs/**/*.md" --packageName MyDocsServer

Usage

docs-to-mcp-cli --docs <pattern> --packageName <n> [--outDir <dir>] [--toolName <name>]

Options

  • -d, --docs <pattern>: Glob pattern for markdown files (required)
  • -p, --packageName <n>: Name for the generated MCP server (required)
  • -o, --outDir <dir>: Output directory for the bundled server (default: “dist”)
  • -t, --toolName <name>: Name of the tool/package/library being documented (used in tool descriptions)
  • -v, --version: Output the current version

Examples

# Generate a server from all markdown files in the docs directory
docs-to-mcp-cli --docs "docs/**/*.md" --packageName ProjectDocs

# Specify a custom tool name and output directory
docs-to-mcp-cli --docs "documentation/**/*.md" --packageName APIDocsServer --toolName "My API" --outDir build

# Run the generated server
node dist/index.js

Generated Server Tools

The generated MCP server provides the following tools to AI assistants:

  • list_docs: Lists all available documents with a preview of their content
  • get_doc: Gets the full content of a specific document by its path
  • search_docs: Searches across all documents using fuzzy matching

Integration with AI Assistants

Once your MCP server is running, AI assistants that support the Model Context Protocol can connect to it and access your documentation. This enables the AI to provide more accurate and contextual responses based on your specific documentation.

Development

To build the CLI tool locally:

# Clone the repository
git clone https://github.com/Tiberriver256/docs-to-mcp-cli.git
cd docs-to-mcp-cli

# Install dependencies
npm install

# Build the project
npm run build

# Link for local development
npm link

Current Version

The current version is 1.1.2. See the CHANGELOG.md for details on recent updates.

Tools

No tools

Comments

Recommend MCP Servers

View All MCP Servers