Skip to content

README.md

Latest commit

 

History

History
57 lines (38 loc) · 3.49 KB

README.md

File metadata and controls

57 lines (38 loc) · 3.49 KB

Agent Guidelines

Overview

Agent-specific guidelines for the PatternFly MCP project, optimized for machine processing.

File Naming Convention

  • agent_*: Guidance for autonomous agents

Guidelines Index

Agent Guidelines

Skills

  • Add docs links - Add documentation links to src/docs.json in a structured way (format, duplicate check, URL confirmation, tests)

Note: guidelines/skills/ is the canonical location for skills. Repo symlinks point here so agents can discover them: .agents/skills (Cursor), .claude/skills (Claude). The .agent/ directory (no “s”) is reserved for each developer’s local work and is off limits—do not use it for shared skills or guidelines.

User Guide

Available Trigger Phrases

Agents should use these phrases as signals to consult specific documentation and source code:

Task / Intent Reference Document
"review the repo guidelines" Scan markdown files and guidelines directory. See AI agent context.
"review app architecture" Review docs/architecture.md for current to future state, then review src/* for up-to-date specs.
"review tool usage" Review docs/usage.md for built-in tools and configuration.
"review development guide" Review docs/development.md for CLI, API, and plugin authoring.
"create an example tool plugin" Review guidelines/agent_coding.md, docs/development.md, docs/examples/*, and src/* for context, coding standards, and existing example formats.
"add documentation links" / "add doc entries" / "register docs" / "update docs.json" / "contribute to docs.json" Follow guidelines/skills/add-docs-links/SKILL.md: docs.json format, duplicate check, raw URL confirmation, then run unit tests and update meta.

Guidelines Processing Order

  1. Guidelines Directory (all files in the guidelines/ directory)
  2. Local guidelines (.agent/ directory) — reserved for each user’s agent interaction; gitignored and off limits for shared repo assets. Do not create or reference shared skills or guidelines in .agent/.

Maintaining This Directory

File Maintenance Principles

  • Update index files (e.g., docs/examples/README.md or guidelines/README.md) immediately when adding or removing content.
  • Reference and index guidelines. Don't duplicate content.
  • Update references when adding new files.
  • Keep descriptions concise and focused.

Adding New Guidelines

  1. Add entry to "Guidelines Index" section
  2. Include essential metadata
  3. Provide brief description
  4. Update processing order if needed