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.9.tar.gz (62.1 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.9-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: starlog_mcp-0.1.9.tar.gz
  • Upload date:
  • Size: 62.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for starlog_mcp-0.1.9.tar.gz
Algorithm Hash digest
SHA256 615e3476e5414285340de8eb88c383f6468a990346a28e63267d9a10c6c03fc4
MD5 3895531f8c612c987102ffb2bb2e83b9
BLAKE2b-256 c547d6df34f69509a91fcd3c390224638cfff0d75a55e38c56cd752c9b0c3c78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: starlog_mcp-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for starlog_mcp-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f548362ee90859034f297268b5f10029c88aa13c5bec6f82d2e276507783933a
MD5 5d870b4893c1fc595e8e57e4073c8e5d
BLAKE2b-256 df8dc0283693b50a03e0b4bec5cebb70465360ef3a0d7b537034834753e55c4b

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