Skip to main content

STARLOG documentation workflow MCP for Claude Code integration

Project description

STARLOG MCP

STARLOG (Session, Task, and Activity Record LOG) is a comprehensive documentation workflow system designed for Claude Code integration via the Model Context Protocol (MCP).

Overview

STARLOG provides three integrated documentation types:

  • RULES: Project guidelines with brain-agent enforcement
  • DEBUG_DIARY: Real-time development tracking with GitHub issue integration
  • STARLOG: Session history with START/END markers for context continuity

Features

🏗️ Project Initialization

  • Automated project setup with registry creation
  • Integrated starlog.hpi file generation
  • Context-aware project configuration

📏 Rules System

  • Hierarchical rule management with categories and priorities
  • Brain-agent enforcement integration
  • Dynamic rule validation and compliance checking

📓 Debug Diary

  • Real-time development issue tracking
  • Direct GitHub Issues API integration
  • Automatic bug report and fix workflow

📋 Session Management

  • Comprehensive session START/END tracking
  • Goal-oriented work sessions with outcomes
  • Historical context preservation

🧭 HPI (Human-Programming Interface) System

  • Automatic context assembly from latest session + debug diary
  • Project orientation for seamless context switching
  • Documentation-driven development workflow

Installation

[Installation instructions pending PyPI publication]

Quick Start

Initialize a STARLOG Project

from starlog_mcp import Starlog

starlog = Starlog()
result = starlog.init_project("my_project", "My Project Name")
print(result)

Add Project Rules

result = starlog.add_rule("Always write tests", "my_project", "testing")
print(result)

Start a Development Session

session_data = {
    "session_title": "Feature Implementation",
    "start_content": "Implementing user authentication",
    "context_from_docs": "Based on security requirements doc",
    "session_goals": ["Add login", "Add logout", "Add password reset"]
}
result = starlog.start_starlog(session_data, "my_project")
print(result)

Get Project Context

context = starlog.orient("my_project")
print(context)  # Complete project context for AI assistance

MCP Server Usage

STARLOG includes a built-in MCP server for Claude Code integration:

starlog-server

Environment Variables

  • HEAVEN_DATA_DIR: Directory for STARLOG data storage (default: /tmp/heaven_data)
  • OPENAI_API_KEY: Required for brain-agent rule enforcement

MCP Configuration

Add to your Claude Code configuration:

{
  "mcpServers": {
    "starlog": {
      "command": "starlog-server",
      "env": {
        "HEAVEN_DATA_DIR": "/path/to/your/data",
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

Available MCP Tools

  • init_project(path, name) - Initialize new STARLOG project
  • rules(path) - View all project rules
  • add_rule(rule, path, category) - Add new rule
  • update_debug_diary(diary_entry, path) - Add debug diary entry
  • view_debug_diary(path) - View debug diary
  • start_starlog(session_data, path) - Start new session
  • view_starlog(path) - View session history
  • end_starlog(session_id, end_content, path) - End session
  • orient(path) - Get complete project context
  • check(path) - Check project status

Development

Running Tests

pytest tests/

Development Installation

pip install -e .[dev]

Architecture

STARLOG uses the HEAVEN framework's registry system for persistent storage and provides a clean FastMCP-based server implementation for seamless Claude Code integration.

Registry Pattern

Data is stored in isolated registries per project:

  • {project_name}_rules - Project rules with enforcement metadata
  • {project_name}_debug_diary - Development tracking entries
  • {project_name}_starlog - Session history with goals and outcomes

License

MIT License - see LICENSE file for details.

Contributing

Contributions welcome! Please see CONTRIBUTING.md for guidelines.

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

starlog_mcp-0.1.7.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

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

starlog_mcp-0.1.7-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file starlog_mcp-0.1.7.tar.gz.

File metadata

  • Download URL: starlog_mcp-0.1.7.tar.gz
  • Upload date:
  • Size: 60.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starlog_mcp-0.1.7.tar.gz
Algorithm Hash digest
SHA256 d5f6d775706272c13bb7de0c7298dd31109d79e6aaf6b1ee0e801dc952507c9c
MD5 09f698084185987453d4ab62581b9e5e
BLAKE2b-256 5ecf0c761f7ba6c6913f77caf646e494cfdffefa257bc8abd2c54dd573684465

See more details on using hashes here.

File details

Details for the file starlog_mcp-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: starlog_mcp-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 41.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starlog_mcp-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9f62622773b25189b746a58e68013c2d14b389080d70e9b0f00a833bf80e4c04
MD5 a55522335ddb1fa1646bf3eaf24ff4bc
BLAKE2b-256 1eede8db643546125f3126ec9648c783947900ca5d8b0935e1a4874f9612e02c

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