### Initialize Simone Project Source: https://github.com/helmi/claude-simone/blob/master/documentation/legacy-installation.md Initializes the Simone project by analyzing the codebase and creating initial project documents. This process is guided conversationally through an AI chat interface. ```plaintext /simone:initialize ``` -------------------------------- ### Install hello-simone with MCP Version Source: https://github.com/helmi/claude-simone/blob/master/hello-simone/README.md Installs the new Model Context Protocol (MCP) version of Simone. This option configures the project's .mcp.json, creates a .simone/config.yaml template, and provides setup instructions for Claude Desktop. ```bash npx hello-simone --mcp ``` -------------------------------- ### Install hello-simone Source: https://github.com/helmi/claude-simone/blob/master/hello-simone/README.md Installs the Simone AI-powered project management system using npx. This is the default installation command. ```bash npx hello-simone ``` -------------------------------- ### Install Legacy Simone System Source: https://github.com/helmi/claude-simone/blob/master/documentation/legacy-installation.md Installs the legacy Simone system and sets up necessary directories and templates. This command can also be used to update an existing installation, with automatic backups of command files. ```bash npx hello-simone ``` -------------------------------- ### Install Dependencies (Yarn) Source: https://github.com/helmi/claude-simone/blob/master/documentation/README.md Installs project dependencies using Yarn. This is the first step before running any other commands. ```bash yarn ``` -------------------------------- ### Install hello-simone with Legacy Version Source: https://github.com/helmi/claude-simone/blob/master/hello-simone/README.md Installs the original directory-based version of Simone. This can be done explicitly with the --legacy flag or by using the default command. ```bash npx hello-simone --legacy ``` ```bash npx hello-simone ``` -------------------------------- ### MCP Server Configuration (.mcp.json) Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-installation.md Example of a .mcp.json configuration file to enable the MCP server for a project. It specifies the command to run the server, arguments, and environment variables, including the essential PROJECT_PATH. ```json { "mcpServers": { "simone": { "command": "npx", "args": ["--yes", "simone-mcp@latest"], "env": { "PROJECT_PATH": "/path/to/your/project" } } } } ``` -------------------------------- ### Install Simone MCP Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/README.md Installs the Simone MCP server using the hello-simone package manager. This command should be run from the project's root directory. ```bash npx hello-simone --mcp ``` -------------------------------- ### Initialize Simone Project Source: https://github.com/helmi/claude-simone/blob/master/documentation/initialize.md The `initialize` command is used to set up the Simone framework within a project. It guides the user through project analysis, documentation handling (including importing existing docs or creating new ones), and initial project setup, culminating in the creation of a project manifest. ```bash /simone:initialize ``` -------------------------------- ### Create Tasks for Current Sprint Source: https://github.com/helmi/claude-simone/blob/master/documentation/legacy-installation.md Generates actionable tasks for the current sprint based on the latest state of the codebase. This command is executed per sprint to ensure task relevance. ```plaintext /simone:create_sprint_tasks ``` -------------------------------- ### Start Local Development Server (Yarn) Source: https://github.com/helmi/claude-simone/blob/master/documentation/README.md Starts a local development server for the Docusaurus website. Changes are reflected live without server restarts. ```bash yarn start ``` -------------------------------- ### Install MCP Server Globally Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-installation.md Installs the Simone MCP server as a global command-line tool using npm. This is recommended for users who will frequently interact with the MCP server. ```bash npm install -g simone-mcp ``` -------------------------------- ### Install Legacy Simone with NPM Source: https://github.com/helmi/claude-simone/blob/master/CLAUDE.md Installs the legacy Simone system using NPM. This command is used to set up the stable, production-ready version of the Simone system for project management. ```bash npx hello-simone ``` -------------------------------- ### Run MCP Server Directly Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-installation.md Executes the Simone MCP server directly using npx without a global installation. This is useful for testing or infrequent usage. ```bash npx simone-mcp ``` -------------------------------- ### MCP Server Configuration Example Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/CLAUDE.md Demonstrates how to configure the Simone MCP server within a project's `.mcp.json` file, specifying the command to execute, arguments, and environment variables. ```JSON { "mcpServers": { "simone": { "command": "npx", "args": ["simone-mcp"], "env": { "PROJECT_PATH": "/path/to/project" } } } } ``` -------------------------------- ### Create Sprints from Milestone Source: https://github.com/helmi/claude-simone/blob/master/documentation/legacy-installation.md Analyzes a defined milestone's requirements to break them down into smaller, manageable sprints. This command facilitates the planning process within the Simone system. ```plaintext /simone:create_sprints_from_milestone ``` -------------------------------- ### GitHub Integration Partial Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md Illustrates the usage of a Handlebars partial `{{> github}}` to manage GitHub tool selection. This partial informs the LLM whether to use the GitHub MCP or CLI based on project configuration, abstracting the tool choice. ```handlebars {{> github}} Create an issue with title "Bug: Login fails" and appropriate labels. ``` -------------------------------- ### Run Project Quality Checks (Handlebars) Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md This snippet demonstrates how to use the 'quality-checks' Handlebars partial to run all configured quality checks, such as linting, testing, and type checking, after implementing changes. ```handlebars After implementing your changes: {{> quality-checks}} Ensure all checks pass before proceeding. ``` -------------------------------- ### Do Task Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/prompt-reference.md A simple prompt to instruct the AI to start working on a specific task. It requires a `task_id` and provides the AI with the initial project context. ```YAML --- # Example structure for do_task prompt definition prompt: do_task description: "A simple prompt to instruct the AI to begin work on a specific task." arguments: - name: task_id required: true description: "The ID of the task to be executed." usage: "This prompt serves as the entry point for the AI to start an implementation task, providing it with the initial context of the project and the task ID." ``` -------------------------------- ### Create Task Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/prompt-reference.md An interactive prompt to guide users and AI in defining and creating new tasks. It helps elicit requirements, explore solutions, and generate task specifications for GitHub issues. ```YAML --- # Example structure for create-task prompt definition prompt: create-task description: "An interactive prompt that guides the user and AI through the process of defining and creating a new task." usage: "This prompt is designed to be used conversationally to elicit requirements, explore solutions, and generate a well-defined task specification, which can then be used to create a GitHub issue." arguments: [] ``` -------------------------------- ### Create GitHub Issue (Markdown) Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md Provides a clear instruction for creating a GitHub issue using the GitHub CLI. It specifies the required components: Title (with character limit), Body (from previous step), and Labels (bug or enhancement). ```markdown ## 3 · Create GitHub issue Create issue using GitHub CLI with: - Title: Clear, concise summary (max 72 chars) - Body: The drafted content from step 2 - Labels: bug (if fixing), enhancement (if adding) ``` -------------------------------- ### Conditional Logic with Handlebars Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md Demonstrates how to implement conditional logic in prompts using Handlebars based on risk levels. It allows for different actions, such as user confirmation or immediate execution, depending on the project's risk assessment. ```handlebars {{#if (eq project.riskLevel 1)}} - Ask user for confirmation before proceeding {{else if (lte project.riskLevel 5)}} - Show plan and proceed unless user objects {{else}} - Execute immediately without confirmation {{/if}} ``` -------------------------------- ### Standard Prompt Structure Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md Defines the mandatory structure for Simone MCP prompts, including name, description, arguments, and a detailed template for LLM instructions. The template emphasizes a top-to-bottom execution flow with clear steps and output formatting. ```yaml name: prompt_name description: Brief, clear description of what this prompt does arguments: - name: optional_argument description: Clear description required: false template: | # Action Verb + Object **IMPORTANT:** Follow from Top to Bottom - don't skip anything! **CREATE A TODO LIST** with exactly these N items: 1. First high-level step 2. Second high-level step 3. ... N. Final step ## 1 · First detailed step [Detailed instructions...] ## 2 · Second detailed step [Detailed instructions...] ## N · Final step with output [Final instructions and output format...] ``` -------------------------------- ### Interview Pattern for User Input Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md A Handlebars pattern for gathering user input, essential due to MCP argument limitations. It conditionally asks the user for input if an argument is not provided, ensuring all necessary information is collected. ```handlebars ## 1 · Gather user input {{#if argument_name}} Initial input provided: "{{argument_name}}" {{else}} Ask the user: "What is [the specific thing you need]?" {{/if}} Additional questions to ask: - [Specific question 1] - [Specific question 2] - [Context-gathering question] ``` -------------------------------- ### Conditional User Interaction (Handlebars) Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/PROMPT-STYLE-GUIDE.md Illustrates conditional user interaction logic in Handlebars based on a project's risk level. If the risk level is below 5, the agent asks for clarification; otherwise, it makes a reasonable assumption. ```handlebars {{#if (lt project.riskLevel 5)}} - Ask user for clarification {{else}} - Make reasonable assumption and note in output {{/if}} ``` -------------------------------- ### Configure Simone Workflow Auto-Commit Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/WORKFLOW-CONFIG-EXAMPLE.md This YAML snippet shows how to configure the `autoCommit` feature in the Simone project's `.simone/project.yaml` file. Setting `autoCommit` to `false` enables a manual checkpoint before the prompt automatically commits changes and creates a Pull Request, facilitating manual testing. ```yaml project: name: my-project features: workflow: autoCommit: false # Set to false to enable manual testing checkpoint ``` -------------------------------- ### Methodology Configuration Options Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/CONFIG-SCHEMA-AUDIT.md Specifies the development methodology, architecture, and workflow. Currently not used, but has potential to guide test-first suggestions and structure suggestions. ```yaml methodology: development: tdd|bdd|none # Should guide test-first suggestions architecture: clean|mvc|microservices|none # Should affect structure suggestions workflow: gitflow|github-flow|trunk-based|none # Should affect branch strategies ``` -------------------------------- ### Configure Project with project.yaml Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-workflow.md Defines the project's structure, stack, and tooling by creating or updating the `.simone/project.yaml` file. This configuration influences the server's prompt and tool behavior. ```yaml project: name: "MySimoneProject" stack: "python" tools: - "git" - "docker" ``` -------------------------------- ### Build Static Website Content (Yarn) Source: https://github.com/helmi/claude-simone/blob/master/documentation/README.md Generates the static content for the website into the 'build' directory, ready for hosting. ```bash yarn build ``` -------------------------------- ### Development Commands Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/CLAUDE.md Provides a list of essential commands for developing the MCP server using pnpm, covering tasks like running in development mode, building, testing, linting, formatting, type checking, and cleaning artifacts. ```Bash pnpm dev # Development mode with hot-reload pnpm build # Build for production pnpm test # Run tests pnpm test:coverage # Run tests with coverage pnpm lint # Lint code pnpm format # Format code with Prettier pnpm typecheck # Type checking pnpm clean # Clean build artifacts ``` -------------------------------- ### Invoke MCP Server Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-workflow.md Initiates actions by invoking a prompt by name, such as `create-task` or `summarize-activity`. The server renders a detailed prompt using Handlebars templating based on project configuration and arguments. ```bash mcp-server prompt create-task --title "Implement User Authentication" --description "Add secure user login and registration functionality." ``` -------------------------------- ### Stack Configuration Details Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/CONFIG-SCHEMA-AUDIT.md Defines the project's stack, including language, framework, database, and styling. Currently, only 'enabled' flags are checked, but it should actively inform code generation and provide context-aware examples. ```yaml stack: language: string # Should inform syntax highlighting, file extensions framework: name: string version: string enabled: boolean database: type: string orm: string enabled: boolean styling: system: string enabled: boolean ``` -------------------------------- ### Project Structure Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/CLAUDE.md Illustrates the directory layout for the MCP server project, highlighting source code, build output, test coverage, and configuration files. ```Plaintext ./mcp-server/ ├── src/ # TypeScript source │ ├── config/ # Configuration management │ ├── templates/ # Handlebars templates and prompts │ ├── tools/ # MCP tools (activity logger, etc.) │ ├── types/ # TypeScript type definitions │ └── utils/ # Utility functions ├── dist/ # Build output (gitignored) ├── coverage/ # Test coverage (gitignored) ├── package.json ├── tsconfig.json ├── vitest.config.ts ├── eslint.config.js └── README.md ``` -------------------------------- ### Pre-Commit Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/prompt-reference.md Dynamically generates a pre-commit checklist based on project configuration (`.simone/project.yaml`). It includes quality assurance steps like linting and testing to act as a final quality gate before commits. ```YAML --- # Example structure for pre-commit prompt definition prompt: pre-commit description: "Generates a pre-commit checklist for the developer or AI." usage: "This prompt dynamically generates a checklist of quality assurance steps (like linting, testing, and formatting) based on the project's configuration in `.simone/project.yaml`. It serves as a final quality gate before code is committed." ``` -------------------------------- ### Deploy Website (Yarn - SSH) Source: https://github.com/helmi/claude-simone/blob/master/documentation/README.md Deploys the website using SSH. This command builds the site and pushes it to the 'gh-pages' branch, suitable for GitHub Pages. ```bash USE_SSH=true yarn deploy ``` -------------------------------- ### Run Simone MCP Tests Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/README.md Provides commands to run the comprehensive test suite for the Simone MCP server. Includes options for running all tests, running tests in watch mode, and generating a coverage report. ```bash pnpm test # Run all tests pnpm test:watch # Run tests in watch mode pnpm test:coverage # Run tests with coverage report ``` -------------------------------- ### Create Git Tags for Components (Bash) Source: https://github.com/helmi/claude-simone/blob/master/versions/README.md Creates Git tags for different components within the Simone repository. This includes tagging the MCP server, hello-simone, and legacy Simone components. ```bash npm run tag:mcp # Tag MCP server ``` ```bash npm run tag:hello # Tag hello-simone ``` ```bash npm run tag:legacy # Tag legacy Simone ``` -------------------------------- ### Configure Simone MCP Server Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/README.md Manually configures the Simone MCP server by adding settings to the project's .mcp.json file. This includes specifying the command, arguments, and environment variables for the MCP server. ```json { "mcpServers": { "simone": { "command": "npx", "args": ["--yes", "simone-mcp@latest"], "env": { "PROJECT_PATH": "/path/to/your/project" } } } } ``` -------------------------------- ### Deploy Website (Yarn - No SSH) Source: https://github.com/helmi/claude-simone/blob/master/documentation/README.md Deploys the website without using SSH. Requires specifying the GitHub username. This command builds the site and pushes it to the 'gh-pages' branch. ```bash GIT_USER= yarn deploy ``` -------------------------------- ### Summarize Activity Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/prompt-reference.md Generates a summary of development activity from the activity log. It can filter by a specified `period` (e.g., 'today', '7d') and provides an overview, daily breakdowns, and productivity analysis. ```YAML --- # Example structure for summarize-activity prompt definition prompt: summarize-activity description: "Generates a comprehensive summary of development activity based on the activity log." arguments: - name: period required: false default: "today" description: "The time period to summarize (e.g., `today`, `7d`). Defaults to `today`." usage: "This prompt queries the activity log database and generates a report including an overview, daily breakdowns, and analysis of productivity patterns." ``` -------------------------------- ### List Component Versions (Bash) Source: https://github.com/helmi/claude-simone/blob/master/versions/README.md Lists all component versions managed by the Simone repository using an npm script. This command reads version information from the `versions.json` file. ```bash npm run version:list ``` -------------------------------- ### Version Manager Script Commands Source: https://github.com/helmi/claude-simone/blob/master/versions/VERSIONING.md A set of bash commands to interact with the version manager script. These commands allow listing component versions, creating Git tags for specific components, syncing the central versions.json file with package.json files, and migrating old tags to a new naming scheme. ```bash # List all component versions and their tag status node scripts/version-manager.js list # Create a git tag for a component node scripts/version-manager.js tag mcp-server # Sync versions.json with package.json files node scripts/version-manager.js sync # Migrate old tags to new naming scheme node scripts/version-manager.js migrate-tags ``` -------------------------------- ### Mock File System Implementation Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/TESTING.md Provides a mock implementation for the file system, enabling the simulation of file operations without actual disk access. This is crucial for testing file-related functionalities in isolation. ```typescript export function createMockFileSystem(): MockFS ``` -------------------------------- ### Generate Changelog Prompt Source: https://github.com/helmi/claude-simone/blob/master/documentation/prompt-reference.md A utility prompt to assist in creating human-readable changelog entries. It leverages the `conventional-changelog` tool to generate and format commit messages for a `CHANGELOG.md` file. ```YAML --- # Example structure for generate-changelog prompt definition prompt: generate-changelog description: "A utility prompt to help with the creation of human-readable changelog entries." usage: "It instructs the AI to run the `conventional-changelog` tool to generate raw commit messages and then rewrite them into a user-friendly format suitable for a `CHANGELOG.md` file." ``` -------------------------------- ### Log Activity with log_activity Tool Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-workflow.md Logs significant actions during the development process using the `log_activity` tool. This creates a persistent, queryable history of project development, which can be used by other prompts. ```bash mcp-server tool log_activity --activity "Created new task: Implement User Authentication" --details "Task ID: TSK-123" ``` -------------------------------- ### Markdown for AI Instructions (Markdown) Source: https://github.com/helmi/claude-simone/blob/master/documentation/introduction.md Markdown files are used to provide human-readable instructions for AI agents to execute complex tasks within the Simone framework. ```markdown ## AI-Guided Commands Utilizes human-readable Markdown files as detailed instructions for AI agents to execute complex tasks. ``` -------------------------------- ### Prompt Handler Templating (Conceptual) Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-architecture.md Manages prompt loading, caching, and rendering using Handlebars for dynamic templating. Supports both built-in and project-specific prompts. ```typescript // Conceptual example of prompt rendering import Handlebars from 'handlebars'; interface PromptData { projectName: string; // ... other context data } function renderPrompt(templateString: string, data: PromptData): string { const template = Handlebars.compile(templateString); return template(data); } ``` -------------------------------- ### Handlebars Templating for Prompts (Handlebars) Source: https://github.com/helmi/claude-simone/blob/master/documentation/introduction.md Handlebars templating is used to create dynamic and configurable prompts for AI agents, allowing for context-aware interactions. ```handlebars // Example of a Handlebars template for a dynamic prompt const promptTemplate = "Given the following project context: {{projectContext}}, please perform the task: {{taskDescription}}."; ``` -------------------------------- ### Running Simone MCP Server Tests Source: https://github.com/helmi/claude-simone/blob/master/mcp-server/docs/TESTING.md A collection of bash commands for executing the test suite for the Simone MCP server. It covers running all tests, watch mode, coverage reports, specific file execution, and filtering by test type. ```bash # Run all tests pnpm test # Run tests in watch mode pnpm test:watch # Run with coverage pnpm test:coverage # Run specific test file pnpm test src/config/loader.test.ts # Run only unit tests pnpm test src/config/ src/templates/ src/tools/ ``` -------------------------------- ### Execute Next Task with do_task Source: https://github.com/helmi/claude-simone/blob/master/documentation/do_task.md Initiates the AI to pick up the next available development task. The AI will automatically select an open task from the current sprint or the general task list if no specific task ID is provided. ```bash /simone:do_task ``` -------------------------------- ### Server Core Initialization (TypeScript) Source: https://github.com/helmi/claude-simone/blob/master/documentation/mcp-architecture.md The main entry point of the MCP Server application. It initializes the server using the '@modelcontextprotocol/sdk', sets up request handlers, and establishes the communication transport layer. ```typescript // Example of server core initialization (conceptual) import { MCP } from '@modelcontextprotocol/sdk'; import { StdioServerTransport } from '@modelcontextprotocol/sdk/transport'; async function main() { const transport = new StdioServerTransport(); const mcp = new MCP(transport); // Setup request handlers and other server logic here // ... await mcp.start(); console.log('MCP Server started.'); } main().catch(console.error); ```