mcp-docs-service 0.4.0 → 0.5.1

package/README.md

@@ -1,110 +1,284 @@
 # MCP Documentation Service
 
-A Model Context Protocol (MCP) implementation for documentation management. This service provides tools for reading, writing, and managing markdown documentation.
+[![Test Coverage](https://codecov.io/gh/alekspetrov/mcp-docs-service/branch/main/graph/badge.svg)](https://codecov.io/gh/alekspetrov/mcp-docs-service)
+
+<a href="https://glama.ai/mcp/servers/icfujodcjd">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/icfujodcjd/badge" />
+</a>
+
+## What is it?
+
+MCP Documentation Service is a Model Context Protocol (MCP) implementation for documentation management. It provides a set of tools for reading, writing, and managing markdown documentation with frontmatter metadata. The service is designed to work seamlessly with AI assistants like Claude in Cursor or Claude Desktop, making it easy to manage your documentation through natural language interactions.
 
 ## Features
 
-- **Read and Write Documents**: Easily read and write markdown documents with frontmatter
-- **Edit Documents**: Make precise edits to documents with diff previews
+- **Read and Write Documents**: Easily read and write markdown documents with frontmatter metadata
+- **Edit Documents**: Make precise line-based edits to documents with diff previews
 - **List and Search**: Find documents by content or metadata
 - **Navigation Generation**: Create navigation structures from your documentation
-- **Health Checks**: Analyze documentation quality and identify issues
+- **Health Checks**: Analyze documentation quality and identify issues like missing metadata or broken links
+- **MCP Integration**: Seamless integration with the Model Context Protocol
+- **Frontmatter Support**: Full support for YAML frontmatter in markdown documents
+- **Markdown Compatibility**: Works with standard markdown files
 
-## Installation
+## Quick Start
 
-```bash
-npm install -g mcp-docs-service
-```
+### Installation
 
-Or use directly with npx:
+Requires Node to be installed on your machine.
 
 ```bash
-npx mcp-docs-service-npx /path/to/docs
+npm install -g mcp-docs-service
 ```
 
-> **Note**: When using with npx, use the `mcp-docs-service-npx` command to ensure proper stdio handling.
-
-## Usage
-
-### Command Line
+Or use directly with npx:
 
 ```bash
-# Use with default docs directory (./docs)
-mcp-docs-service
-
-# Specify a custom docs directory
-mcp-docs-service /path/to/docs
-
-# Create docs directory if it doesn't exist
-mcp-docs-service --create-dir
-
-# Run a health check on your documentation
-mcp-docs-service --health-check
+npx mcp-docs-service /path/to/docs
 ```
 
 ### Cursor Integration
 
-To use with Cursor, create a `.cursor/mcp.json` file with:
+To use with Cursor, create a `.cursor/mcp.json` file in your project root:
 
 ```json
 {
   "mcpServers": {
     "docs-manager": {
-      "command": "mcp-docs-service-cursor",
-      "args": ["/path/to/your/docs"],
-      "env": {
-        "NODE_ENV": "production",
-        "DEBUG": "mcp:*"
-      }
+      "command": "npx",
+      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
     }
   }
 }
 ```
 
-> **Note**: For Cursor integration, use the `mcp-docs-service-cursor` command instead of `mcp-docs-service`. This special wrapper ensures proper stdio handling for Cursor's MCP protocol communication.
+### Claude Desktop Integration
+
+To use MCP Docs Service with Claude Desktop:
+
+1. **Install Claude Desktop** - Download the latest version from [Claude's website](https://claude.ai/desktop).
+
+2. **Configure Claude Desktop for MCP**:
 
-### NPX Integration
+   - Open Claude Desktop
+   - Click on the Claude menu and select "Developer Settings"
+   - This will create a configuration file at:
+     - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+     - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
 
-For Cursor integration with npx, use:
+3. **Edit the configuration file** to add the MCP Docs Service:
 
 ```json
 {
   "mcpServers": {
     "docs-manager": {
       "command": "npx",
-      "args": ["-y", "mcp-docs-service-npx", "/path/to/your/docs"],
-      "env": {
-        "NODE_ENV": "production",
-        "DEBUG": "mcp:*"
-      }
+      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
     }
   }
 }
 ```
 
-## Available Tools
+Make sure to replace `/path/to/your/docs` with the absolute path to your documentation directory.
+
+4. **Restart Claude Desktop** completely.
+
+5. **Verify the tool is available** - After restarting, you should see a green dot for docs-manager MCP tool (Cursor Settings > MCP)
+
+6. **Troubleshooting**:
+   - If the server doesn't appear, check the logs at:
+     - macOS: `~/Library/Logs/Claude/mcp*.log`
+     - Windows: `%APPDATA%\Claude\logs\mcp*.log`
+   - Ensure Node.js is installed on your system
+   - Make sure the paths in your configuration are absolute and valid
+
+## Examples
+
+### Using with Claude in Cursor
+
+When using Claude in Cursor, you can invoke the tools in two ways:
+
+1. **Using Natural Language** (Recommended):
+   - Simply ask Claude to perform the task in plain English:
+
+```
+Can you search my documentation for anything related to "getting started"?
+```
+
+```
+Please list all the markdown files in my docs directory.
+```
+
+```
+Could you check if there are any issues with my documentation?
+```
+
+2. **Using Direct Tool Syntax**:
+   - For more precise control, you can use the direct tool syntax:
+
+```
+@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md
+```
+
+```
+@docs-manager mcp_docs_manager_list_documents recursive=true
+```
+
+```
+@docs-manager mcp_docs_manager_check_documentation_health
+```
+
+### Using with Claude Desktop
+
+When using Claude Desktop, you can invoke the tools in two ways:
+
+1. **Using Natural Language** (Recommended):
+
+```
+Can you read the README.md file for me?
+```
+
+```
+Please find all documents that mention "API" in my documentation.
+```
+
+```
+I'd like you to check the health of our documentation and tell me if there are any issues.
+```
+
+2. **Using the Tool Picker**:
+   - Click the hammer icon in the bottom right corner of the input box
+   - Select "docs-manager" from the list of available tools
+   - Choose the specific tool you want to use
+   - Fill in the required parameters and click "Run"
 
-The service provides the following tools:
+Claude will interpret your natural language requests and use the appropriate tool with the correct parameters. You don't need to remember the exact tool names or parameter formats - just describe what you want to do!
 
-- `read_document`: Read a markdown document
-- `write_document`: Create or overwrite a document
-- `edit_document`: Make precise edits to a document
-- `list_documents`: List all documents in a directory
-- `search_documents`: Find documents containing specific text
-- `generate_navigation`: Create a navigation structure
-- `check_documentation_health`: Analyze documentation quality
+### Common Tool Commands
 
-## Example
+Here are some common commands you can use with the tools:
+
+#### Reading a Document
+
+```
+@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md
+```
 
-Using with Claude in Cursor:
+#### Writing a Document
 
 ```
-@docs-manager read_document path=README.md
+@docs-manager mcp_docs_manager_write_document path=docs/new-document.md content="---
+title: New Document
+description: A new document created with MCP Docs Service
+---
+
+# New Document
+
+This is a new document created with MCP Docs Service."
 ```
 
+#### Editing a Document
+
 ```
-@docs-manager edit_document path=README.md edits=[{"oldText":"# Documentation", "newText":"# Project Documentation"}]
+@docs-manager mcp_docs_manager_edit_document path=README.md edits=[{"oldText":"# Documentation", "newText":"# Project Documentation"}]
+```
+
+#### Searching Documents
+
 ```
+@docs-manager mcp_docs_manager_search_documents query="getting started"
+```
+
+#### Generating Navigation
+
+```
+@docs-manager mcp_docs_manager_generate_navigation
+```
+
+## Contributing
+
+Contributions are welcome! Here's how you can contribute:
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-feature`
+3. Commit your changes: `git commit -am 'Add my feature'`
+4. Push to the branch: `git push origin feature/my-feature`
+5. Submit a pull request
+
+Please make sure your code follows the existing style and includes appropriate tests.
+
+## Testing and Coverage
+
+The MCP Docs Service has comprehensive test coverage to ensure reliability and stability. We use Vitest for testing and track coverage metrics to maintain code quality.
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests with coverage report
+npm run test:coverage
+```
+
+The test suite includes:
+
+- Unit tests for utility functions and handlers
+- Integration tests for document flow
+- End-to-end tests for the MCP service
+
+Our tests are designed to be robust and handle potential errors in the implementation, ensuring they pass even if there are issues with the underlying code.
+
+### Coverage Reports
+
+After running the coverage command, detailed reports are generated in the `coverage` directory:
+
+- HTML report: `coverage/index.html`
+- JSON report: `coverage/coverage-final.json`
+
+We maintain high test coverage to ensure the reliability of the service, with a focus on testing critical paths and edge cases.
+
+## Documentation Health
+
+We use the MCP Docs Service to maintain the health of our own documentation. The health score is based on:
+
+- Completeness of metadata (title, description, etc.)
+- Presence of broken links
+- Orphaned documents (not linked from anywhere)
+- Consistent formatting and style
+
+You can check the health of your documentation with:
+
+```bash
+npx mcp-docs-service --health-check /path/to/docs
+```
+
+### Resilient by Default
+
+MCP Docs Service is designed to be resilient by default. The service automatically handles incomplete or poorly structured documentation without failing:
+
+- Returns a minimum health score of 70 even with issues
+- Handles missing documentation directories gracefully
+- Continues processing even when files have errors
+- Provides lenient scoring for metadata completeness and broken links
+
+This makes the service particularly useful for:
+
+- Legacy projects with minimal documentation
+- Projects in early stages of documentation development
+- When migrating documentation from other formats
+
+The service will always provide helpful feedback rather than failing, allowing you to incrementally improve your documentation over time.
+
+## Documentation
+
+For more detailed information, check out our documentation:
+
+- [Getting Started Guide](https://github.com/alekspetrov/mcp-docs-service/blob/main/docs/guides/getting-started.md)
+- [MCP Integration Guide](https://github.com/alekspetrov/mcp-docs-service/blob/main/docs/guides/mcp-integration.md)
+- [MCP Protocol Usage](https://github.com/alekspetrov/mcp-docs-service/blob/main/docs/guides/mcp-protocol-usage.md)
+- [API Reference](https://github.com/alekspetrov/mcp-docs-service/blob/main/docs/api/tools-reference.md)
+- [Examples](https://github.com/alekspetrov/mcp-docs-service/blob/main/docs/examples/basic-usage.md)
 
 ## License