mcp-guide 1.0.0__tar.gz

mcp_guide-1.0.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 David L Nugent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcp_guide-1.0.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.3
+Name: mcp-guide
+Version: 1.0.0
+Summary: MCP Server for handling guidelines, project rules and a controlled development workflow
+Author: David Nugent
+Author-email: David Nugent <davidn@uniquode.io>
+License: # MIT License
+         
+         Copyright (c) 2025 David L Nugent
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Communications
+Requires-Dist: mcp[cli]>=1.16.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: aioshutil>=1.6
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: chevron>=0.14.0
+Requires-Dist: click>=8.3.0
+Requires-Dist: uuid7>=0.1.0
+Requires-Dist: patch-ng>=1.19.0
+Requires-Dist: packaging>=24.0
+Requires-Dist: mkdocs>=1.5.0 ; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.5.0 ; extra == 'docs'
+Requires-Dist: mike>=2.0.0 ; extra == 'docs'
+Requires-Dist: yq>=3.0.0 ; extra == 'docs'
+Requires-Dist: uvicorn>=0.27.0 ; extra == 'http'
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/deeprave/mcp-guide
+Project-URL: Documentation, https://deeprave.github.io/mcp-guide/
+Project-URL: Repository, https://github.com/deeprave/mcp-guide
+Project-URL: Issues, https://github.com/deeprave/mcp-guide/issues
+Provides-Extra: docs
+Provides-Extra: http
+Description-Content-Type: text/markdown
+
+# mcp-guide
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/python-mcp-docs.yml?branch=main&label=docs&logo=github)](https://github.com/deeprave/mcp-guide/actions/workflows/python-mcp-docs.yml)
+[![Security](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/codeql.yml?branch=main&label=security&logo=github)](https://github.com/deeprave/mcp-guide/security/code-scanning)
+[![Maintenance](https://img.shields.io/badge/maintenance-active-brightgreen.svg)](https://github.com/deeprave/mcp-guide)
+[![PyPI version](https://img.shields.io/pypi/v/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
+[![Python versions](https://img.shields.io/pypi/pyversions/mcp-guide.svg?logo=python&logoColor=white)](https://pypi.org/project/mcp-guide/)
+
+**Structured content delivery for AI agents via Model Context Protocol**
+
+mcp-guide is an MCP server that provides AI agents with organised access to project guidelines, documentation, and context. It helps agents understand your project's standards, follow development workflows, and access relevant information through a flexible content management system.
+
+## Key Features
+
+- **Content Management** - Organise documents, instructions and prompts by category and collection
+- **Template Support** - Dynamic content with Mustache/Chevron templates
+- **Multiple Transports** - STDIO, HTTP, and HTTPS modes
+- **Feature Flags** - Project-specific and global configuration
+- **Workflow Management** - Structured development phase tracking
+- **Profile System** - Pre-configured setups for common scenarios
+- **Docker Support** - Containerised deployment with SSL
+- **OpenSpec Integration** - Spec-driven development workflow
+
+## Quick Start
+
+mcp-guide is run using your AI Agent's MCP configuration, and not usually run directly, at least in stdio transport mode.
+In stdio mode, standard input and output are used to communicate with the MCP so the agent needs to control both in order
+to operate.
+In http mode, however, the server provides web server (http) transport, and this may be started in standalone mode, not
+necessarily by the agent directly (although typically it does).
+
+The configurations below detail configuration with some cli agents, but almost all of them will be similar.
+
+### Configure with AI Agents
+
+#### JSON configuration
+
+These blocks can be used as is and inserted into the agent's configuration.
+The stdio mode is a straightforward configuration, although it requires the uv tool to be installed.
+
+##### Stdio
+```json
+{
+  "mcpServers": {
+    "mcp-guide": {
+      "command": "uvx",
+      "args": ["mcp-guide"]
+    }
+  }
+}
+```
+
+If the "mcpServers" block already exists, add the "mcp-guide" block at the end, ensuring that the previously last item, if any, has a terminating comma.
+
+#### Kiro-CLI
+
+Add the above JSON block to `~/.kiro/settings/mcp.json`.
+
+#### Claude Code
+
+Add the above JSON block to `~/.claude/settings.json`.
+
+#### GitHub Copilot CLI
+
+Add this JSON block to `~/.config/.copilot/mcp.json`.
+
+Other clients will offer similar configuration, some also
+
+See the [Installation Guide](docs/user/installation.md) for more detail in use with various clients, use with docker and using the http/sse transport mode.
+
+## Content Organisation
+
+mcp-guide organises content using **frontmatter** (optional YAML metadata at the start of documents) to define document properties and behaviour.
+
+Content is classified into three types via the `type:` field in frontmatter:
+
+  - **user/information** - Content displayed to users
+  - **agent/information** - Context for AI agents
+  - **agent/instruction** - Directives for agent behaviour
+
+Content is organised using **categories** (file patterns and directories) and **collections** (groups of categories). Collections act as "macros" to provide targeted context for specific tasks or purposes.
+
+See [Content Management](docs/user/content-management.md) for details.
+
+## Feature Flags
+
+Feature flags control behaviour, capabilities and special features and may be set globally or per project:
+
+- **workflow** - Enable workflow phase tracking
+- **openspec** - Enable OpenSpec integration
+- **content-style** - Output format (None, plain, mime)
+
+See [Feature Flags](docs/user/feature-flags.md) for more information.
+
+## Documentation
+
+- **[Documentation Index](docs/index.md)** - Documentation overview
+- **[Getting Started](docs/user/getting-started.md)** - First-time setup and basic concepts
+- **[Changelog](CHANGELOG.md)** - Release notes and version history
+
+## Links
+
+- **Documentation**: [docs/user/](docs/index.md)
+- **Issues**: [GitHub Issues](https://github.com/deeprave/mcp-guide/issues)
+- **MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io/)
+
+## License
+
+MIT License - See [LICENSE.md](LICENSE.md) for details.

mcp_guide-1.0.0/README.md

@@ -0,0 +1,110 @@
+# mcp-guide
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/python-mcp-docs.yml?branch=main&label=docs&logo=github)](https://github.com/deeprave/mcp-guide/actions/workflows/python-mcp-docs.yml)
+[![Security](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/codeql.yml?branch=main&label=security&logo=github)](https://github.com/deeprave/mcp-guide/security/code-scanning)
+[![Maintenance](https://img.shields.io/badge/maintenance-active-brightgreen.svg)](https://github.com/deeprave/mcp-guide)
+[![PyPI version](https://img.shields.io/pypi/v/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
+[![Python versions](https://img.shields.io/pypi/pyversions/mcp-guide.svg?logo=python&logoColor=white)](https://pypi.org/project/mcp-guide/)
+
+**Structured content delivery for AI agents via Model Context Protocol**
+
+mcp-guide is an MCP server that provides AI agents with organised access to project guidelines, documentation, and context. It helps agents understand your project's standards, follow development workflows, and access relevant information through a flexible content management system.
+
+## Key Features
+
+- **Content Management** - Organise documents, instructions and prompts by category and collection
+- **Template Support** - Dynamic content with Mustache/Chevron templates
+- **Multiple Transports** - STDIO, HTTP, and HTTPS modes
+- **Feature Flags** - Project-specific and global configuration
+- **Workflow Management** - Structured development phase tracking
+- **Profile System** - Pre-configured setups for common scenarios
+- **Docker Support** - Containerised deployment with SSL
+- **OpenSpec Integration** - Spec-driven development workflow
+
+## Quick Start
+
+mcp-guide is run using your AI Agent's MCP configuration, and not usually run directly, at least in stdio transport mode.
+In stdio mode, standard input and output are used to communicate with the MCP so the agent needs to control both in order
+to operate.
+In http mode, however, the server provides web server (http) transport, and this may be started in standalone mode, not
+necessarily by the agent directly (although typically it does).
+
+The configurations below detail configuration with some cli agents, but almost all of them will be similar.
+
+### Configure with AI Agents
+
+#### JSON configuration
+
+These blocks can be used as is and inserted into the agent's configuration.
+The stdio mode is a straightforward configuration, although it requires the uv tool to be installed.
+
+##### Stdio
+```json
+{
+  "mcpServers": {
+    "mcp-guide": {
+      "command": "uvx",
+      "args": ["mcp-guide"]
+    }
+  }
+}
+```
+
+If the "mcpServers" block already exists, add the "mcp-guide" block at the end, ensuring that the previously last item, if any, has a terminating comma.
+
+#### Kiro-CLI
+
+Add the above JSON block to `~/.kiro/settings/mcp.json`.
+
+#### Claude Code
+
+Add the above JSON block to `~/.claude/settings.json`.
+
+#### GitHub Copilot CLI
+
+Add this JSON block to `~/.config/.copilot/mcp.json`.
+
+Other clients will offer similar configuration, some also
+
+See the [Installation Guide](docs/user/installation.md) for more detail in use with various clients, use with docker and using the http/sse transport mode.
+
+## Content Organisation
+
+mcp-guide organises content using **frontmatter** (optional YAML metadata at the start of documents) to define document properties and behaviour.
+
+Content is classified into three types via the `type:` field in frontmatter:
+
+  - **user/information** - Content displayed to users
+  - **agent/information** - Context for AI agents
+  - **agent/instruction** - Directives for agent behaviour
+
+Content is organised using **categories** (file patterns and directories) and **collections** (groups of categories). Collections act as "macros" to provide targeted context for specific tasks or purposes.
+
+See [Content Management](docs/user/content-management.md) for details.
+
+## Feature Flags
+
+Feature flags control behaviour, capabilities and special features and may be set globally or per project:
+
+- **workflow** - Enable workflow phase tracking
+- **openspec** - Enable OpenSpec integration
+- **content-style** - Output format (None, plain, mime)
+
+See [Feature Flags](docs/user/feature-flags.md) for more information.
+
+## Documentation
+
+- **[Documentation Index](docs/index.md)** - Documentation overview
+- **[Getting Started](docs/user/getting-started.md)** - First-time setup and basic concepts
+- **[Changelog](CHANGELOG.md)** - Release notes and version history
+
+## Links
+
+- **Documentation**: [docs/user/](docs/index.md)
+- **Issues**: [GitHub Issues](https://github.com/deeprave/mcp-guide/issues)
+- **MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io/)
+
+## License
+
+MIT License - See [LICENSE.md](LICENSE.md) for details.

mcp_guide-1.0.0/pyproject.toml

@@ -0,0 +1,137 @@
+[project]
+name = "mcp-guide"
+version = "1.0.0"
+description = "MCP Server for handling guidelines, project rules and a controlled development workflow"
+readme = "README.md"
+license = {file = "LICENSE.md"}
+authors = [{name = "David Nugent", email = "davidn@uniquode.io"}]
+requires-python = ">=3.11"
+dependencies = [
+    "mcp[cli]>=1.16.0",
+    "pydantic>=2.0",
+    "pyyaml>=6.0",
+    "aioshutil>=1.6",
+    "aiofiles>=23.2.1",
+    "chevron>=0.14.0",
+    "click>=8.3.0",
+    "uuid7>=0.1.0",
+    "patch-ng>=1.19.0",
+    "packaging>=24.0",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Communications",
+]
+
+[project.urls]
+Homepage = "https://github.com/deeprave/mcp-guide"
+Documentation = "https://deeprave.github.io/mcp-guide/"
+Repository = "https://github.com/deeprave/mcp-guide"
+Issues = "https://github.com/deeprave/mcp-guide/issues"
+
+[project.optional-dependencies]
+http = ["uvicorn>=0.27.0"]
+docs = [
+    "mkdocs>=1.5.0",
+    "mkdocs-material>=9.5.0",
+    "mike>=2.0.0",
+    "yq>=3.0.0",
+]
+
+[project.scripts]
+mcp-guide = "mcp_guide.main:main"
+mcp-install = "mcp_guide.scripts.mcp_guide_install:cli"
+guide-agent-install = "mcp_guide.scripts.guide_agent_install:main"
+
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+module-name = ["mcp_guide"]
+source-exclude = [
+    ".DS_Store",
+    ".localized",
+]
+wheel-exclude = [
+    ".DS_Store",
+    ".localized",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+asyncio_mode = "auto"
+filterwarnings = ["error"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--cov=src/mcp_guide",
+    "--cov-report=term-missing",
+]
+markers = [
+    "e2e: marks tests as end-to-end tests",
+    "slow: marks tests as slow running",
+]
+
+[tool.ruff]
+src = ["src"]
+target-version = "py313"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["I", "F401"]  # I = isort, F401 = unused imports
+
+[tool.ruff.lint.isort]
+known-first-party = ["mcp_guide"]
+
+[tool.mypy]
+python_version = "3.13"
+mypy_path = "src"
+files = ["src"]
+strict = true
+namespace_packages = true
+
+[[tool.mypy.overrides]]
+module = "fastmcp"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "uuid_extensions"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "debugpy"
+ignore_missing_imports = true
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-asyncio>=1.2.0",
+    "pytest-cov>=7.0.0",
+    "coverage>=7.10.7",
+    "ruff>=0.13.2",
+    "mypy>=1.18.2",
+    "pre-commit>=4.0.0",
+    "types-aiofiles>=24.1.0.20250822",
+    "types-pyyaml>=6.0.12.20250915",
+    "types-chevron>=0.14.2.20250103",
+    "watchdog>=6.0.0",
+    "bandit>=1.9.2",
+    "pyright>=1.1.407",
+    "osvcheck>=1.0.0b1",
+]
+debug = [
+    "debugpy>=1.8.0",
+]

mcp_guide-1.0.0/src/mcp_guide/__init__.py

@@ -0,0 +1,17 @@
+"""Guide-specific MCP server implementation."""
+
+try:
+    from importlib.metadata import version
+
+    __version__ = version("mcp-guide")
+except Exception:
+    # Fallback: read from pyproject.toml during development
+    import tomllib
+    from pathlib import Path
+
+    pyproject = Path(__file__).parent.parent.parent / "pyproject.toml"
+    if pyproject.exists():
+        with open(pyproject, "rb") as f:
+            __version__ = tomllib.load(f)["project"]["version"]
+    else:
+        __version__ = "unknown"

mcp_guide-1.0.0/src/mcp_guide/agent_detection.py

@@ -0,0 +1,112 @@
+"""Agent detection and information formatting."""
+
+import re
+from dataclasses import dataclass
+from typing import Any, Optional, Union
+
+
+@dataclass
+class AgentInfo:
+    """Information about the MCP client/agent."""
+
+    name: str
+    normalized_name: str
+    version: Optional[str]
+    prompt_prefix: str
+
+
+AGENT_PATTERNS = [
+    (r"q\s+dev", "q-dev"),
+    (r"kiro", "kiro"),
+    (r"claude", "claude"),
+    (r"copilot", "copilot"),
+    (r"gemini", "gemini"),
+    (r"cascade|windsurf", "windsurf"),
+]
+
+AGENT_PREFIX_MAP = {
+    "q-dev": "@",
+    "kiro": "@",
+    "claude": "/",
+    "copilot": "/",
+    "gemini": "/",
+    "windsurf": "/",
+    "unknown": "/",
+}
+
+
+def normalize_agent_name(name: str) -> str:
+    """Normalise agent name to lowercase canonical form.
+
+    Converts agent names to a consistent format:
+    - Whitespace is collapsed and converted to hyphens
+    - Underscores are removed (e.g., "Agent_Name" → "agentname")
+    - Hyphens are preserved (e.g., "Agent-Name" → "agent-name")
+    - Special characters are stripped
+    - Returns "unknown" if result is empty
+    """
+    # Strip and validate input
+    name = name.strip()
+    if not name:
+        return "unknown"
+
+    name_lower = name.lower()
+
+    for pattern, normalized in AGENT_PATTERNS:
+        if re.search(pattern, name_lower):
+            return normalized
+
+    # Normalise whitespace: collapse multiple spaces to single hyphen
+    normalized = re.sub(r"\s+", "-", name_lower)
+    # Remove special characters except hyphens
+    normalized = re.sub(r"[^a-z0-9-]", "", normalized)
+    # Remove leading/trailing hyphens
+    normalized = normalized.strip("-")
+
+    return normalized if normalized else "unknown"
+
+
+def detect_agent(client_params: Union[dict[str, Any], Any]) -> AgentInfo:
+    """Detect agent from client parameters.
+
+    Args:
+        client_params: Either InitializeRequestParams object or dict with clientInfo
+
+    Returns:
+        AgentInfo with detected agent information
+    """
+    # Handle Pydantic model (InitializeRequestParams)
+    if hasattr(client_params, "clientInfo"):
+        client_info = client_params.clientInfo
+        name = client_info.name if client_info else "Unknown"
+        version = client_info.version if client_info else None
+    # Handle dict format (for tests)
+    elif isinstance(client_params, dict):
+        client_info = client_params.get("clientInfo", {})
+        name = client_info.get("name", "Unknown")
+        version = client_info.get("version")
+    else:
+        name = "Unknown"
+        version = None
+
+    normalized_name = normalize_agent_name(name)
+    prompt_prefix = AGENT_PREFIX_MAP.get(normalized_name, "/")
+
+    return AgentInfo(name=name, normalized_name=normalized_name, version=version, prompt_prefix=prompt_prefix)
+
+
+def format_agent_info(agent_info: AgentInfo, mcp_name: str) -> str:
+    """Format agent info for display."""
+    prompt_prefix = agent_info.prompt_prefix.replace("{mcp_name}", mcp_name)
+
+    lines = [
+        f"Agent: {agent_info.name}",
+        f"Normalised Name: {agent_info.normalized_name}",
+    ]
+
+    if agent_info.version:
+        lines.append(f"Version: {agent_info.version}")
+
+    lines.append(f"Command Prefix: {prompt_prefix}")
+
+    return "\n".join(lines)

mcp_guide-1.0.0/src/mcp_guide/agents/README.md

@@ -0,0 +1,62 @@
+# Agent Configurations
+
+This directory contains specialised agent configurations for various agentic CLIs. Each subdirectory contains agent definitions for a specific CLI tool.
+
+## Installation
+
+```bash
+# Install agents for a specific CLI
+guide-agent-install <agent> <dirname>
+
+# Examples
+guide-agent-install kiro ~           # Install kiro agents to ~/.kiro/agents/
+guide-agent-install kiro .           # Install kiro agents to ./.kiro/agents/
+guide-agent-install kiro /path/dir   # Install kiro agents to /path/dir/.kiro/agents/
+```
+
+## Available Agent Sets
+
+### kiro
+
+Agent configurations for [Kiro CLI](https://github.com/aws/amazon-q-developer-cli). See [kiro/README.md](kiro/README.md) for detailed documentation.
+
+**Agents**:
+- `guide` - Structured development workflow with phase-based progression
+- `guide-review` - Code review focusing on correctness, security, and consistency
+- `guide-spec` - Requirements gathering and OpenSpec specification authoring
+
+### claude
+
+Agent configurations for [Claude Code](https://code.claude.com/). See [claude/README.md](claude/README.md) for detailed documentation.
+
+**Agents**:
+- `guide` - Structured development workflow with phase-based progression
+- `guide-review` - Code review focusing on correctness, security, and consistency
+- `guide-spec` - Requirements gathering and OpenSpec specification authoring
+
+### copilot
+
+Agent configurations for [GitHub Copilot](https://github.com/features/copilot). See [copilot/README.md](copilot/README.md) for detailed documentation.
+
+**Agents**:
+- `guide` - Structured development workflow with phase-based progression
+- `guide-review` - Code review focusing on correctness, security, and consistency
+- `guide-spec` - Requirements gathering and OpenSpec specification authoring
+
+## Common Concepts
+
+### Resources
+
+Agents typically have access to:
+- Project documentation (`README.md`, `AGENTS.md`)
+- OpenSpec documentation (`openspec/AGENTS.md`)
+- Project and user-specific rules (`.kiro/rules/**/*.md`, `~/.kiro/rules/**/*.md`)
+
+### Agent Purposes
+
+Agents are designed for specific workflows:
+- **Development workflow agent**: Guide through structured development phases
+- **Review agent**: Analyse code changes for issues and improvements
+- **Specification agent**: Create/maintain technical specs and documentation
+
+Each agent set may have different capabilities and tool access depending on the CLI tool they're designed for.