Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Document Tools

A Python package implementing a variety of document-related tools for converting and processing document formats. These tools are exposed through an MCP server interface for seamless integration with AI assistants.

Setup

# Create a virtual env and activate it
uv venv
source .venv/bin/activate

# Install the package in development mode
uv pip install -e .

Running

# Start the MCP server
uv run main.py

Testing

# Run all tests
uv run pytest

Development

Tool Definitions

Tools are defined as Python functions and registered with the MCP server:

mcp.tool()(my_function)

Tool descriptions should:

  • Begin with a one-line summary
  • Provide detailed explanation of functionality
  • Explain when to use (and not use) the tool
  • Include usage examples with expected input/output

Use Field from pydantic for parameter descriptions:

from pydantic import Field

def my_tool(
    param1: str = Field(description="Detailed description of this parameter"),
    param2: int = Field(description="Explain what this parameter does")
) -> ReturnType:
    """Comprehensive docstring here"""
    # Implementation

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages