技能 scribe-mcp-usage
📝

scribe-mcp-usage

低風險 📁 檔案系統存取⚙️ 外部命令

إدارة وثائق المشروع باستخدام Scribe

غالباً ما تصبح وثائق المشروع قديمة ويصعب تتبعها. يوفر Scribe MCP إدارة موثقة للوثائق مع مسارات التدقيق، والتسجيل التلقائي للتقدم، والتحقق من الروابط المتبادلة للحفاظ على دقة وثائق المشروع ومساءلتها.

支援: Claude Codex Code(CC)
⚠️ 67 差
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「scribe-mcp-usage」。 Initialize project documentation for 'My Project'

預期結果:

  • Called set_project with name='My Project'
  • Generated ARCHITECTURE_GUIDE.md, PHASE_PLAN.md, CHECKLIST.md, PROGRESS_LOG.md
  • Logged project initialization entry with status='plan'

正在使用「scribe-mcp-usage」。 Log progress after completing authentication module

預期結果:

  • [2025-10-22 10:21:14 UTC] [✅] [Agent: Developer] [Project: My Project] Completed authentication module implementation | phase=implementation; component=auth; tests=47/47 passed

正在使用「scribe-mcp-usage」。 Update checklist item for database migration

預期結果:

  • Updated CHECKLIST.md section 'database_migration' from [ ] to [x]
  • Attached proof: PROGRESS_LOG.md#2025-10-22-10-21-14
  • Auto-logged doc_update entry

安全審計

低風險
v6 • 1/21/2026

All static findings are false positives. The skill is documentation for the Scribe MCP tool which manages project documentation. Detected patterns are documentation references, markdown formatting, and metadata - not actual security vulnerabilities.

2
已掃描檔案
3,593
分析行數
3
發現項
6
審計總數
低風險問題 (1)
SKILL.md:10-540
Documentation-only risk factors
The skill contains documentation references to file paths, environment variables, and logging patterns. These are legitimate documentation artifacts for a documentation management tool, not security vulnerabilities.

風險因素

📁 檔案系統存取
未記錄任何特定位置
⚙️ 外部命令
未記錄任何特定位置
審計者: claude 查看審計歷史 →

品質評分

38
架構
100
可維護性
87
內容
20
社群
88
安全
87
規範符合性

你能建構什麼

تهيئة مشروع جديد

إعداد بنية توثيق كاملة للمشاريع الجديدة بما في ذلك دليل البنية التحتية وخطة المرحلة وقائمة التحقق قبل كتابة أي كود.

تتبع التقدم والتسجيل

تسجيل تقدم التطوير مع بيانات وصفية غنية بما في ذلك المرحلة والمكون ومراجع قائمة التحقق للحصول على وثائق جاهزة للتدقيق.

صيانة الوثائق

تحديث ومزامنة وثائق المشروع مع تطور الخطط، مع التسجيل التلقائي لجميع التغييرات عبر manage_docs.

試試這些提示

تهيئة وثائق مشروع جديد 
استخدم مهارة scribe-mcp-usage لإعداد مشروع جديد باسم [Project Name]. استدعِ set_project مع اسم المشروع، ثم استخدم manage_docs لصياغة ARCHITECTURE_GUIDE و PHASE_PLAN و CHECKLIST بناءً على مناقشتنا. سجّل هذه التهيئة باستخدام append_entry.
تسجيل تقدم التطوير 
استخدم append_entry لتسجيل أننا [أكملنا/وجدنا/اكتشفنا] [وصف العمل]. استخدم status=[status] حيث الحالة هي info أو success أو warn أو bug..Include relevant metadata like phase, component, and any checklist IDs.
تحديث وثائق المشروع 
استخدم manage_docs لتحديث وثيقة [doc_name]. للتحديثات على المقاطع، استخدم مرساة المقطع. استخدم apply_patch للتحرير المنظم. سجّل التحديث مع status='update' وأرفق روابط إثبات إلى PROGRESS_LOG.
استعلام تاريخ التقدم 
استخدم query_entries للعثور على [number] إدخالات سجل حديثة لـ [project name] مع status=[status filter, optional]. عرض الإدخالات من آخر [time period] تطابق [message pattern, optional].

最佳實務

  • استدعِ set_project دائمًا قبل أي أداة Scribe أخرى لإنشاء سياق المشروع
  • سجّل إدخالات التقدم كل 2-3 إجراءات ذات معنى أو كل 10 دقائق أثناء التطوير
  • تضمن البيانات الوصفية مثل المرحلة والمكون وchecklist_id لمسارات التدقيق القابلة للاستعلام

避免

  • الكتابة المباشرة للوثائق بدون استخدام manage_docs (يكسر مسار التدقيق)
  • تخطي تسجيل العمل المهم (ينتهك مبدأ التوثيق أولاً)
  • تعديل PROGRESS_LOG يدويًا بدلاً من استخدام append_entry

常見問題

ما هو Scribe MCP؟
Scribe MCP هو خادم Model Context Protocol لإدارة وثائق المشروع. يوفر أدوات لتهيئة وثائق المشروع وتسجيل التقدم والحفاظ على توثيق متزامن مع مسارات التدقيق.
هل أحتاج إلى تسجيل مشروع أولاً؟
نعم. تتطلب جميع أدوات Scribe سياق مشروع نشط. استدعِ set_project(name='Your Project') قبل استخدام أي أداة Scribe أخرى. هذا يهيئة سجل الوثائق.
ما هي الوثائق التي يتم إنشاؤها تلقائيًا؟
يُنشئ set_project أربعة وثائق: ARCHITECTURE_GUIDE.md و PHASE_PLAN.md و CHECKLIST.md و PROGRESS_LOG.md. تشكل هذه الوثائق الأساسية مجموعة التوثيق لكل مشروع.
كيف أسجّل إدخالات التقدم؟
استخدم append_entry مع message وstatus وبيانات وصفية اختيارية. قيم الحالة هي info أو success أو warn أو error أو bug أو plan.Include phase وcomponent وchecklist_id في meta للبحث.
هل يمكنني البحث في إدخالات السجل السابقة؟
نعم. استخدم query_entries مع فلاتر للمشروع أو نطاق التاريخ أو محتوى الحالة أو الحالة أو الوكيل. استخدم read_recent للإدخالات الأخيرة بدون تصفية معقدة.
كيف أحدّث الوثائق بأمان؟
استخدم manage_docs مع apply_patch للتحرير المنظم، أو replace_range للتغييرات السطرية، أو replace_section لبناء المقاطع. يتم تسجيل جميع التغييرات تلقائيًا مع doc_updates.

開發者詳情

作者

CortaLabs

授權

MIT

儲存庫

https://github.com/CortaLabs/scribe_mcp/tree/master/.codex/skills/scribe-mcp-usage

引用

master

檔案結構

📄 SKILL.md