MCP Package Docs

🚀 Package Documentation Tool Usage Guide

The Package Documentation tool is a powerful utility designed to assist developers in quickly accessing documentation for various programming language libraries and frameworks. It offers the following key features:

1. Multi-language Documentation Support: Covers packages/libraries for popular programming languages such as Go, Python, and Rust.
2. Intelligent Search: Enables full-text retrieval within specified language package documentation.
3. Language Server Protocol (LSP) Integration: Provides code highlighting, auto-completion, and error detection capabilities.

📦 Installation

Prerequisites

• Node.js: Version >= 20
• Go: Required for generating Go language documentation.
• Python 3: Used for generating Python language documentation.
• Internet Connection: Necessary for fetching NPM package documentation and Rust crate documentation.

Optional Dependencies (for LSP functionality)

npm install -g typescript-language-server typescript vscode-langservers-extracted

🚀 Quick Start

Install the Tool

npm install package-docs

Common Commands

• Initialize a project: package-docs init
• Generate documentation: package-docs build
• Start development mode: package-docs dev

✨ Features

Retrieve Package Documentation

Go Packages

const goDocResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Describe Go Package",
    arguments: {
        PackageName: "encoding/json", 
        SymbolName: "Marshal"
    }
});

Python Packages

const pythonDocResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Describe Python Package",
    arguments: {
        PackageName: "requests", 
        FunctionName: "post"
    }
});

Rust Libraries

const rustDocResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Describe Rust Package",
    arguments: {
        PackageName: "serde"
    }
});

Search Documentation Content

const searchResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Search Package Documentation",
    arguments: {
        PackageName: "serde", 
        QueryTerm: "Serialization",
        Language: "rust",
        FuzzyMatch: true
    }
});

LSP Functionality Examples

Hover Information

const hoverResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Get Hover Information",
    arguments: {
        LanguageIdentifier: "typescript",
        FilePath: "src/index.ts",
        FileContent: "const axios = require('axios');\naxios.get",
        LineNumber: 1,
        ColumnNumber: 7
    }
});

Code Completion

const completionsResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Get Code Completion",
    arguments: {
        LanguageIdentifier: "typescript",
        FilePath: "src/index.ts", 
        FileContent: "const arr = []; arr.",
        LineNumber: 0,
        ColumnNumber: 8
    }
});

Error Detection

const errorsResult = await useMCPTool({
    serverName: "Package Documentation",
    toolName: "Get Error Information",
    arguments: {
        LanguageIdentifier: "typescript",
        FilePath: "src/index.ts", 
        FileContent: "function foo() { console.log('bar'); }"
    }
});

📚 Documentation

Project Structure

package-docs/
├── src/                 # Source code directory
│   ├── core/           # Core logic module
│   ├── lsp/            # LSP protocol implementation module
│   └── utils/         # Utility function module
└── docs/               # Documentation materials

Development Process

1. Clone the repository: git clone https://github.com/yourusername/package-docs.git
2. Install dependencies: npm install
3. Start the development environment: npm run dev

Usage Instructions

• Initialize a Project: Run package-docs init to create basic configuration files.
• Build Documentation: Use package-docs build to generate documentation for the target language.
• Start the Service: Begin providing documentation services with package-docs start.
• View Logs: Relevant operation logs are located in the ./logs/ directory.

⚠️ Important Note

• Ensure all dependencies are installed before use.
• Code examples are for reference only and should be adjusted according to project requirements.
• For custom extensions, refer to the extension documentation for development.