Project Files
README
Narzędzie umożliwiające modelom AI tworzenie plików Markdown zgodnych ze standardami dokumentacyjnymi (file construction standards).
Plugin udostępnia trzy narzędzia (tools) dla modeli LLM:
create_markdown_fileTworzy plik Markdown z opcjonalnym YAML frontmatter i automatyczną walidacją struktury.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
file_name | string | ✅ | Nazwa pliku z rozszerzeniem .md |
content | string | ✅ | Treść dokumentu Markdown |
template_type | enum | ❌ | Typ szablonu (agent_rules, rosetta_stone, script_vision, script_spec, custom) |
frontmatter | object | ❌ | Dane YAML (id, module, version, strict_mode, dependencies, ai_behavior) |
force | boolean | ❌ | Nadpisz istniejący plik |
validate_markdown_structureWaliduje strukturę Markdown pod kątem zgodności ze standardami.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
content | string | ✅ | Treść do walidacji |
fill_templateWypełnia szablon Markdown danymi i zwraca gotowy dokument. Najbardziej przydatny do tworzenia dokumentacji z wzorców.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
template_type | enum | ✅ | Typ szablonu (script_vision, script_spec, rosetta_stone, agent_rules) |
data | object | ✅ | Dane do wypełnienia szablonu |
frontmatter | object | ❌ | Dane do YAML frontmatter |
Przykładowe dane dla script_vision:
{ "script_name": "backup-manager", "problem": "Brak automatycznego backupu plików konfiguracyjnych", "concept": "Skrypt tworzy kopie zapasowe z timestempem", "required_context": [".planCS", "settings.yaml"], "data_sources": ["settings.yaml", ".planCS"], "user_stories": [ "Użytkownik uruchamia: ./backup.sh --config prod", "Skrypt tworzy backup w folderze backups/" ] }
Plugin wymaga od modelu przestrzegania następujących standardów:
--- id: "UNIQUE-UUID-OR-ID" module: "core_engine" version: "2.1.0" strict_mode: true dependencies: [".env", "settings.yaml"] ai_behavior: "critical_honesty" ---
Status:: InProgress Priority:: High Owner:: Agent-01
§: §1.1, §2.3@@ID:nazwa---{{nazwa}} lub [Nazwa]> [!NOTE], > [!TIP], > [!WARNING]npm install npm run build
Prośba do modelu:
Stwórz plik
docs/agent_rules.mdz zasadami agenta dla modułu "auth_system", wersja 1.0.0, z frontmatter i sekcjami §1-§4.
Model wywołuje tool:
{ "file_name": "docs/agent_rules.md", "content": "# 🎯 Zasady Agenta: auth_system\n\n## §1. Filozofia\n...\n## §2. Zasady\n...", "frontmatter": { "id": "agent-rules-auth-001", "module": "auth_system", "version": "1.0.0", "strict_mode": true, "ai_behavior": "critical_honesty" } }
markdown-builder-plugin/ ├── package.json ├── tsconfig.json ├── src/ │ ├── index.ts # Entry point pluginu │ ├── toolsProvider.ts # Definicje tooli │ ├── schemas.ts # Schematy Zod │ └── templates.ts # Definicje szablonów Markdown └── README.md
MIT
Project Files
README
Narzędzie umożliwiające modelom AI tworzenie plików Markdown zgodnych ze standardami dokumentacyjnymi (file construction standards).
Plugin udostępnia trzy narzędzia (tools) dla modeli LLM:
create_markdown_fileTworzy plik Markdown z opcjonalnym YAML frontmatter i automatyczną walidacją struktury.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
file_name | string | ✅ | Nazwa pliku z rozszerzeniem .md |
content | string | ✅ | Treść dokumentu Markdown |
template_type | enum | ❌ | Typ szablonu (agent_rules, rosetta_stone, script_vision, script_spec, custom) |
frontmatter | object | ❌ | Dane YAML (id, module, version, strict_mode, dependencies, ai_behavior) |
force | boolean | ❌ | Nadpisz istniejący plik |
validate_markdown_structureWaliduje strukturę Markdown pod kątem zgodności ze standardami.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
content | string | ✅ | Treść do walidacji |
fill_templateWypełnia szablon Markdown danymi i zwraca gotowy dokument. Najbardziej przydatny do tworzenia dokumentacji z wzorców.
Parametry:
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
template_type | enum | ✅ | Typ szablonu (script_vision, script_spec, rosetta_stone, agent_rules) |
data | object | ✅ | Dane do wypełnienia szablonu |
frontmatter | object | ❌ | Dane do YAML frontmatter |
Przykładowe dane dla script_vision:
{ "script_name": "backup-manager", "problem": "Brak automatycznego backupu plików konfiguracyjnych", "concept": "Skrypt tworzy kopie zapasowe z timestempem", "required_context": [".planCS", "settings.yaml"], "data_sources": ["settings.yaml", ".planCS"], "user_stories": [ "Użytkownik uruchamia: ./backup.sh --config prod", "Skrypt tworzy backup w folderze backups/" ] }
Plugin wymaga od modelu przestrzegania następujących standardów:
--- id: "UNIQUE-UUID-OR-ID" module: "core_engine" version: "2.1.0" strict_mode: true dependencies: [".env", "settings.yaml"] ai_behavior: "critical_honesty" ---
Status:: InProgress Priority:: High Owner:: Agent-01
§: §1.1, §2.3@@ID:nazwa---{{nazwa}} lub [Nazwa]> [!NOTE], > [!TIP], > [!WARNING]npm install npm run build
Prośba do modelu:
Stwórz plik
docs/agent_rules.mdz zasadami agenta dla modułu "auth_system", wersja 1.0.0, z frontmatter i sekcjami §1-§4.
Model wywołuje tool:
{ "file_name": "docs/agent_rules.md", "content": "# 🎯 Zasady Agenta: auth_system\n\n## §1. Filozofia\n...\n## §2. Zasady\n...", "frontmatter": { "id": "agent-rules-auth-001", "module": "auth_system", "version": "1.0.0", "strict_mode": true, "ai_behavior": "critical_honesty" } }
markdown-builder-plugin/ ├── package.json ├── tsconfig.json ├── src/ │ ├── index.ts # Entry point pluginu │ ├── toolsProvider.ts # Definicje tooli │ ├── schemas.ts # Schematy Zod │ └── templates.ts # Definicje szablonów Markdown └── README.md
MIT
graph TD
A -→ B
graph TD
A -→ B