Template Generator

hatch.template_generator

Template Generator for Hatch packages.

This module contains functions to generate template files for Hatch MCP server packages. Each function generates a specific file for the package template.

Functions

create_package_template(target_dir, package_name, description='')

Create a package template directory with all necessary files.

This function orchestrates the generation of a complete package structure by: 1. Creating the package directory 2. Generating and writing the init.py file 3. Generating and writing the mcp_server.py file with example tools 4. Generating and writing the hatch_mcp_server_entry.py file that wraps the MCP server 5. Creating the hatch_metadata.json with package information 6. Generating a README.md with basic documentation

Parameters:

Name	Type	Description	Default
target_dir	Path	Directory where the package should be created.	required
package_name	str	Name of the package.	required
description	str	Package description. Defaults to empty string.	''

Returns:

Name	Type	Description
Path	Path	Path to the created package directory.

Source code in hatch/template_generator.py

def create_package_template(
    target_dir: Path, package_name: str, description: str = ""
) -> Path:
    """Create a package template directory with all necessary files.

    This function orchestrates the generation of a complete package structure by:
    1. Creating the package directory
    2. Generating and writing the __init__.py file
    3. Generating and writing the mcp_server.py file with example tools
    4. Generating and writing the hatch_mcp_server_entry.py file that wraps the MCP server
    5. Creating the hatch_metadata.json with package information
    6. Generating a README.md with basic documentation

    Args:
        target_dir (Path): Directory where the package should be created.
        package_name (str): Name of the package.
        description (str, optional): Package description. Defaults to empty string.

    Returns:
        Path: Path to the created package directory.
    """
    logger.info(f"Creating package template for {package_name} in {target_dir}")

    # Create package directory
    package_dir = target_dir / package_name
    package_dir.mkdir(parents=True, exist_ok=True)

    # Create __init__.py
    init_content = generate_init_py()
    with open(package_dir / "__init__.py", "w") as f:
        f.write(init_content)

    # Create mcp_server.py
    mcp_server_content = generate_mcp_server_py(package_name)
    with open(package_dir / "mcp_server.py", "w") as f:
        f.write(mcp_server_content)

    # Create hatch_mcp_server_entry.py
    hatch_mcp_server_entry_content = generate_hatch_mcp_server_entry_py(package_name)
    with open(package_dir / "hatch_mcp_server_entry.py", "w") as f:
        f.write(hatch_mcp_server_entry_content)

    # Create metadata.json
    metadata = generate_metadata_json(package_name, description)
    with open(package_dir / "hatch_metadata.json", "w") as f:
        json.dump(metadata, f, indent=2)

    # Create README.md
    readme_content = generate_readme_md(package_name, description)
    with open(package_dir / "README.md", "w") as f:
        f.write(readme_content)

    logger.info(f"Package template created successfully at {package_dir}")
    return package_dir

generate_hatch_mcp_server_entry_py(package_name)

Generate the hatch_mcp_server_entry.py file content for a template package.

Parameters:

Name	Type	Description	Default
package_name	str	Name of the package.	required

Returns:

Name	Type	Description
str	str	Content for hatch_mcp_server_entry.py file.

Source code in hatch/template_generator.py

def generate_hatch_mcp_server_entry_py(package_name: str) -> str:
    """Generate the hatch_mcp_server_entry.py file content for a template package.

    Args:
        package_name (str): Name of the package.

    Returns:
        str: Content for hatch_mcp_server_entry.py file.
    """
    return f"""from hatch_mcp_server import HatchMCP
from mcp_server import mcp

hatch_mcp = HatchMCP(\"{package_name}\",
                     fast_mcp=mcp,
                     origin_citation=\"Origin citation for {package_name}\",
                     mcp_citation=\"MCP citation for {package_name}\")

if __name__ == \"__main__\":
    hatch_mcp.server.run()
"""

generate_init_py()

Generate the init.py file content for a template package.

Returns:

Name	Type	Description
str	str	Content for init.py file.

Source code in hatch/template_generator.py

def generate_init_py() -> str:
    """Generate the __init__.py file content for a template package.

    Returns:
        str: Content for __init__.py file.
    """
    return "# Hatch package initialization\n"

generate_mcp_server_py(package_name)

Generate the mcp_server.py file content for a template package.

Parameters:

Name	Type	Description	Default
package_name	str	Name of the package.	required

Returns:

Name	Type	Description
str	str	Content for mcp_server.py file.

Source code in hatch/template_generator.py

def generate_mcp_server_py(package_name: str) -> str:
    """Generate the mcp_server.py file content for a template package.

    Args:
        package_name (str): Name of the package.

    Returns:
        str: Content for mcp_server.py file.
    """
    return f"""from mcp.server.fastmcp import FastMCP

mcp = FastMCP(\"{package_name}\", log_level=\"WARNING\")

@mcp.tool()
def example_tool(param: str) -> str:
    \"\"\"Example tool function.

    Args:
        param (str): Example parameter.

    Returns:
        str: Example result.
    \"\"\"
    return f\"Processed: {{param}}\"

if __name__ == \"__main__\":
    mcp.run()
"""

generate_metadata_json(package_name, description='')

Generate the metadata JSON content for a template package.

Parameters:

Name	Type	Description	Default
package_name	str	Name of the package.	required
description	str	Package description. Defaults to empty string.	''

Returns:

Name	Type	Description
dict	dict	Metadata dictionary.

Source code in hatch/template_generator.py

def generate_metadata_json(package_name: str, description: str = "") -> dict:
    """Generate the metadata JSON content for a template package.

    Args:
        package_name (str): Name of the package.
        description (str, optional): Package description. Defaults to empty string.

    Returns:
        dict: Metadata dictionary.
    """
    return {
        "package_schema_version": "1.2.1",
        "name": package_name,
        "version": "0.1.0",
        "description": description or f"A Hatch package for {package_name}",
        "tags": [],
        "author": {"name": "Hatch User", "email": ""},
        "license": {"name": "MIT"},
        "entry_point": {
            "mcp_server": "mcp_server.py",
            "hatch_mcp_server": "hatch_mcp_server_entry.py",
        },
        "tools": [{"name": "example_tool", "description": "Example tool function"}],
        "citations": {
            "origin": f"Origin citation for {package_name}",
            "mcp": f"MCP citation for {package_name}",
        },
    }

generate_readme_md(package_name, description='')

Generate the README.md file content for a template package.

Parameters:

Name	Type	Description	Default
package_name	str	Name of the package.	required
description	str	Package description. Defaults to empty string.	''

Returns:

Name	Type	Description
str	str	Content for README.md file.

Source code in hatch/template_generator.py

def generate_readme_md(package_name: str, description: str = "") -> str:
    """Generate the README.md file content for a template package.

    Args:
        package_name (str): Name of the package.
        description (str, optional): Package description. Defaults to empty string.

    Returns:
        str: Content for README.md file.
    """
    return f"""# {package_name}

{description}

## Tools

- **example_tool**: Example tool function
"""