pip install hoxcore

# Clone the repository
git clone https://github.com/SDEscobedo/hoxcore
cd hoxcore

# Create a virtual environment (optional but recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .

# Initialize a registry in the current directory
hxc init

# Initialize in a specific directory
hxc init ~/my-registry

# Initialize without git integration
hxc init --no-git

# Create a basic project
hxc create project "My First Project"

# Create a project with a description, tags, and due date
hxc create project "API Redesign" --description "Redesign the public API" --tags backend api --due-date 2025-06-01

# Create a program (container for projects)
hxc create program "Q2 Initiatives"

# Create a mission (execution-oriented, time-bound)
hxc create mission "Deploy v2.0"

# Create an action (ongoing, no end date)
hxc create action "Monitor system health"

# List all projects
hxc list project

# List all entities in the registry
hxc list all

# Filter by status or tag
hxc list project --status active
hxc list project --tag backend

# Show full details of a specific entity
hxc show <uid>

# Get a specific property
hxc get <uid> status

# Change status or add a tag
hxc edit <uid> --set-status completed
hxc edit <uid> --add-tag backend

# Set a new due date
hxc edit <uid> --set-due-date 2025-06-01

# Delete an entity (prompts for confirmation)
hxc delete <uid>

# Delete immediately without prompt
hxc delete <uid> --force

# Prevent automatic commit after deletion
hxc delete <uid> --no-commit

# General help
hxc --help

# Command-specific help
hxc create --help
hxc list --help

# Start with the default or configured registry
hxc mcp

# Start with a specific registry path
hxc mcp --registry /path/to/your/registry

# Specify transport (currently only stdio is supported)
hxc mcp --transport stdio

# Show server capabilities (tools, resources, prompts) without starting
hxc mcp --capabilities

# Start in read-only mode — write tools are not exposed to the LLM
hxc mcp --read-only

from hxc.mcp.server import create_server

# Normal mode (all tools)
server = create_server(registry_path="/path/to/registry")
server.run_stdio()

# Read-only mode (write tools omitted)
server = create_server(registry_path="/path/to/registry", read_only=True)
server.run_stdio()

{
  "mcpServers": {
    "hoxcore": {
      "command": "hxc",
      "args": ["mcp", "--registry", "/path/to/your/registry"]
    }
  }
}

{
  "mcpServers": {
    "hoxcore": {
      "command": "hxc",
      "args": ["mcp", "--registry", "/path/to/your/registry", "--read-only"]
    }
  }
}

from hxc.mcp.server import create_server

server = create_server()

# Register a custom tool
def my_tool(registry_path=None, **kwargs):
    """My custom tool description."""
    return {"result": "..."}

server.register_tool("my_tool", my_tool)

# Register a custom prompt
server.register_prompt({
    "name": "my_prompt",
    "description": "A helpful prompt template",
    "arguments": [
        {"name": "context", "description": "Context for the prompt", "required": True}
    ]
})

server.run_stdio()