Skip to main content

MCP server which contains tools for Home Clean Home chatbot service.

Project description

Home Clean Home MCP Server

Overview

A Model Context Protocol server for managing residential and commercial cleaning services. This server provides tools to retrieve service details, pricing, and booking requirements dynamically via Large Language Models.

Please note that Home Clean Home MCP Server is currently in active development. The functionality and available tools are subject to change and expansion as we continue to improve the server.

Tools

Residential Services

  1. get_residential_service_general_info

    • Provides general information about a selected residential cleaning service.
    • Input:
      • service (string, required): Select a residential service option from the following:
        • Detail Cleaning
        • Move In Cleaning
        • Move Out Cleaning
        • Post-Renovation Cleaning
        • Spring Cleaning (Occupied Unit)
        • Floor Cleaning or Floor Care
        • Formaldehyde (VOC)
        • Disinfecting
        • Household Accessory Cleaning (e.g. Sofa, Mattress, Carpet, Curtains)
        • Customised or Combination Cleaning
    • Returns: General information about the selected service.
  2. get_residential_service_price_info

    • Provides pricing details for a selected residential cleaning service.
    • Input:
      • service (string, required): Same options as above.
    • Returns: Pricing details for the selected service.
  3. get_residential_service_booking_requirements

    • Lists booking requirements for a selected residential cleaning service.
    • Input:
      • service (string, required): Same options as above.
    • Returns: Booking requirements for the selected service.

Commercial Services

  1. get_commercial_service_general_info

    • Provides general information about a selected commercial cleaning service.
    • Input:
      • service (string, required): Select a commercial service option from the following:
        • Commercial Cleaning
        • Placeholder Option
    • Returns: General information about the selected service.
  2. get_commercial_service_price_info

    • Provides pricing details for a selected commercial cleaning service.
    • Input:
      • service (string, required): Same options as above.
    • Returns: Pricing details for the selected service.
  3. get_commercial_service_booking_requirements

    • Lists booking requirements for a selected commercial cleaning service.
    • Input:
      • service (string, required): Same options as above.
    • Returns: Booking requirements for the selected service.

Installation

Using uv (recommended)

When using uv, no specific installation is needed. Use uvx to directly run mcp-server-hch.

Using PIP

Alternatively, you can install the server via pip:

pip install mcp-server-hch

After installation, you can run it as a script using:

python -m mcp_server_hch

Configuration

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

  1. Using uv/uvx(if already published to PYPI)
"mcpServers": {
  "mcp-server-hch": {
    "command": "uv",
    "args": [
      "--directory",
      "local_path/to/mcp_server_hch",
      "run",
      "mcp-server-hch"
    ]
  }
}
"mcpServers": {
  "mcp-server-hch": {
    "command": "uvx",
    "args": ["mcp-server-hch"]
  }
}
  1. Using pip installation
"mcpServers": {
  "mcp-server-hch": {
    "command": "python",
    "args": ["-m", "mcp_server_hch"]
  }
}

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx mcp-server-hch

Or if you've installed the package in a specific directory or are developing locally:

npx @modelcontextprotocol/inspector uv --directory local_path/to/mcp_server_hch run mcp-server-hch

Running tail -n 20 -f ~/Library/Logs/Claude/mcp*.log will show the logs from the server and may help you debug any issues.

Development

If you are doing local development, there are two ways to test your changes:

  1. Run the MCP inspector to test your changes. See Debugging for run instructions.

  2. Test using the Claude desktop app. Add the following to your claude_desktop_config.json:

"mcpServers": {
  "mcp-server-hch": {
    "command": "uv",
    "args": [
      "--directory",
      "local_path/to/mcp_server_hch",
      "run",
      "mcp-server-hch"
    ]
  }
}

Build and publish to PYPI

To build the project:

uv sync --dev --all-extras
uv build

Publish project to PYPI(required PYPI account for API Token):

uv publish

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_hch-0.0.0.tar.gz (75.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_hch-0.0.0-py3-none-any.whl (58.5 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_hch-0.0.0.tar.gz.

File metadata

  • Download URL: mcp_server_hch-0.0.0.tar.gz
  • Upload date:
  • Size: 75.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for mcp_server_hch-0.0.0.tar.gz
Algorithm Hash digest
SHA256 0f4511d7d8fd4859678cf255b09ec49a5f125ac1f3b40c260fd63c96b3ad828b
MD5 84f539ed989a8ae117092b4e6b1805c5
BLAKE2b-256 4144ce1d0dd892a64841025896aff1929d57da9794700869e4cfcea7acc661ff

See more details on using hashes here.

File details

Details for the file mcp_server_hch-0.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_hch-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a6368fd9dd027295844c188a672fff850f009dfb2bfbf273ccb03387ebe0c17
MD5 6c502dddc1d8ca9a9770950fc1510a2e
BLAKE2b-256 02883cb67af05fc4509c82dd7b8fdb843db95ce6bf817cd176cf1f80c99825e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page