starlog-mcp


Namestarlog-mcp JSON
Version 0.1.10 PyPI version JSON
download
home_pagehttps://github.com/anthropics/claude-code
SummarySTARLOG documentation workflow MCP for Claude Code integration
upload_time2025-11-02 18:16:41
maintainerNone
docs_urlNone
authorIsaac and Claude
requires_python>=3.8
licenseMIT
keywords mcp documentation workflow starlog claude-code
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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

```python
from starlog_mcp import Starlog

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

### Add Project Rules

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

### Start a Development Session

```python
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

```python
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:

```bash
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:

```json
{
  "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

```bash
pytest tests/
```

### Development Installation

```bash
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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/anthropics/claude-code",
    "name": "starlog-mcp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mcp, documentation, workflow, starlog, claude-code",
    "author": "Isaac and Claude",
    "author_email": "Isaac and Claude <noreply@anthropic.com>",
    "download_url": null,
    "platform": null,
    "description": "# STARLOG MCP\n\nSTARLOG (Session, Task, and Activity Record LOG) is a comprehensive documentation workflow system designed for Claude Code integration via the Model Context Protocol (MCP).\n\n## Overview\n\nSTARLOG provides three integrated documentation types:\n- **RULES**: Project guidelines with brain-agent enforcement\n- **DEBUG_DIARY**: Real-time development tracking with GitHub issue integration\n- **STARLOG**: Session history with START/END markers for context continuity\n\n## Features\n\n### \ud83c\udfd7\ufe0f Project Initialization\n- Automated project setup with registry creation\n- Integrated starlog.hpi file generation\n- Context-aware project configuration\n\n### \ud83d\udccf Rules System\n- Hierarchical rule management with categories and priorities\n- Brain-agent enforcement integration\n- Dynamic rule validation and compliance checking\n\n### \ud83d\udcd3 Debug Diary\n- Real-time development issue tracking\n- Direct GitHub Issues API integration\n- Automatic bug report and fix workflow\n\n### \ud83d\udccb Session Management\n- Comprehensive session START/END tracking\n- Goal-oriented work sessions with outcomes\n- Historical context preservation\n\n### \ud83e\udded HPI (Human-Programming Interface) System  \n- Automatic context assembly from latest session + debug diary\n- Project orientation for seamless context switching\n- Documentation-driven development workflow\n\n## Installation\n\n[Installation instructions pending PyPI publication]\n\n## Quick Start\n\n### Initialize a STARLOG Project\n\n```python\nfrom starlog_mcp import Starlog\n\nstarlog = Starlog()\nresult = starlog.init_project(\"my_project\", \"My Project Name\")\nprint(result)\n```\n\n### Add Project Rules\n\n```python\nresult = starlog.add_rule(\"Always write tests\", \"my_project\", \"testing\")\nprint(result)\n```\n\n### Start a Development Session\n\n```python\nsession_data = {\n    \"session_title\": \"Feature Implementation\",\n    \"start_content\": \"Implementing user authentication\",\n    \"context_from_docs\": \"Based on security requirements doc\",\n    \"session_goals\": [\"Add login\", \"Add logout\", \"Add password reset\"]\n}\nresult = starlog.start_starlog(session_data, \"my_project\")\nprint(result)\n```\n\n### Get Project Context\n\n```python\ncontext = starlog.orient(\"my_project\")\nprint(context)  # Complete project context for AI assistance\n```\n\n## MCP Server Usage\n\nSTARLOG includes a built-in MCP server for Claude Code integration:\n\n```bash\nstarlog-server\n```\n\n### Environment Variables\n\n- `HEAVEN_DATA_DIR`: Directory for STARLOG data storage (default: `/tmp/heaven_data`)\n- `OPENAI_API_KEY`: Required for brain-agent rule enforcement\n\n### MCP Configuration\n\nAdd to your Claude Code configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"starlog\": {\n      \"command\": \"starlog-server\",\n      \"env\": {\n        \"HEAVEN_DATA_DIR\": \"/path/to/your/data\",\n        \"OPENAI_API_KEY\": \"your-openai-key\"\n      }\n    }\n  }\n}\n```\n\n## Available MCP Tools\n\n- `init_project(path, name)` - Initialize new STARLOG project\n- `rules(path)` - View all project rules\n- `add_rule(rule, path, category)` - Add new rule\n- `update_debug_diary(diary_entry, path)` - Add debug diary entry  \n- `view_debug_diary(path)` - View debug diary\n- `start_starlog(session_data, path)` - Start new session\n- `view_starlog(path)` - View session history\n- `end_starlog(session_id, end_content, path)` - End session\n- `orient(path)` - Get complete project context\n- `check(path)` - Check project status\n\n## Development\n\n### Running Tests\n\n```bash\npytest tests/\n```\n\n### Development Installation\n\n```bash\npip install -e .[dev]\n```\n\n## Architecture\n\nSTARLOG uses the HEAVEN framework's registry system for persistent storage and provides a clean FastMCP-based server implementation for seamless Claude Code integration.\n\n### Registry Pattern\n\nData is stored in isolated registries per project:\n- `{project_name}_rules` - Project rules with enforcement metadata\n- `{project_name}_debug_diary` - Development tracking entries\n- `{project_name}_starlog` - Session history with goals and outcomes\n\n## License\n\nMIT License - see LICENSE file for details.\n\n## Contributing\n\nContributions welcome! Please see CONTRIBUTING.md for guidelines.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "STARLOG documentation workflow MCP for Claude Code integration",
    "version": "0.1.10",
    "project_urls": {
        "Homepage": "https://github.com/sancovp/starlog-mcp",
        "Issues": "https://github.com/sancovp/starlog-mcp/issues",
        "Repository": "https://github.com/sancovp/starlog-mcp"
    },
    "split_keywords": [
        "mcp",
        " documentation",
        " workflow",
        " starlog",
        " claude-code"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "abd6e74e26430c505171ca493fa9845a042aac2662789b2bee1cc12ada3f2461",
                "md5": "7148b120ea843aeb8d3304cb5fd42143",
                "sha256": "70821eecdff02a0f5ecdd3fb02ee383bd22268696a6889cf13ca74573cd0ec70"
            },
            "downloads": -1,
            "filename": "starlog_mcp-0.1.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7148b120ea843aeb8d3304cb5fd42143",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 42283,
            "upload_time": "2025-11-02T18:16:41",
            "upload_time_iso_8601": "2025-11-02T18:16:41.220189Z",
            "url": "https://files.pythonhosted.org/packages/ab/d6/e74e26430c505171ca493fa9845a042aac2662789b2bee1cc12ada3f2461/starlog_mcp-0.1.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-02 18:16:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "anthropics",
    "github_project": "claude-code",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "starlog-mcp"
}
        
Elapsed time: 2.09250s