Skip to main content
Template Instructions

Required Fields:

  • accountId: Required for TwentyCRM sync. Get from TwentyCRM account record or create new account first
  • title: Tool name
  • category: One of: WEBSITE, SELF_HOSTING, OPERATIONAL_TOOLS, SOCIAL_MEDIA, MARKETING_TOOL, DESIGN_CONTENT, AD_SPEND, OFFICE_COWORKING, CRM
  • categoryDisplay: Human-readable category name (Website, Self-Hosting, etc.)

Optional but Recommended:

  • ToolOverviewButton: Component included in template - update accountId and toolName
  • Note Context: Collapsible section at bottom - guides AI note generation
  • accessLink, accessLabel: Direct links to tool access
  • documentationLink: Auto-generated, but can be overridden

After Creating Tool:

  1. Enrich documentation with current use, workflows, etc.
  2. Generate AI note: node scripts/sync-tools/generate-note.js tools/<name>.md
  3. Review and edit generated note if needed
  4. Sync to TwentyCRM: node scripts/sync-tools/sync.js --to-twentycrm tools/<name>.md

See scripts/sync-tools/AGENT_WORKFLOW.md for complete workflow.

[Tool Name]

[Brief description of what this tool does and why it's used]

Current Use​

  • [How the tool is currently being used]
  • [Key features or workflows that are active]
  • [Integration points with other tools]

How It Works​

[Explain the tool's workflow, integration process, or key mechanisms]

Workflow​

  1. [Step 1]
  2. [Step 2]
  3. [Step 3]

Account Access​

  • Access: Tool Name
  • Account type: [Description of account type/plan]
  • Credentials: Stored in password manager
  • API Keys: Stored in [location] (if applicable)

Configuration​

Environment Variables​

# Add any environment variables needed
TOOL_API_KEY=your_key_here
TOOL_ENDPOINT=https://api.example.com

Settings​

[Document important settings, configurations, or setup steps]

Features in Use​

[Feature 1 Name]​

[Description of feature and how it's used]

[Feature 2 Name]​

[Description of feature and how it's used]

Integrations​

With [Other Tool Name]​

[Describe integration setup and workflow]

Automation: [Describe any n8n workflows or automated processes]

See tools/[other-tool].md for related documentation.

Costs and Billing​

  • Monthly Cost: £[X.XX]
  • Annual Cost: £[X.XX] (or calculated from monthly)
  • Billing Cycle: [Monthly|Annual]
  • Next Renewal: [Date]
  • Payment Method: [Card|Invoice|etc.]

Documentation​

Official Resources​

Internal Resources​

  • Setup guide: [Link to internal guide if exists]
  • Training materials: [Link if exists]
  • Exported data: scripts/resources/[tool-name]/

n8n Workflows​

[If this tool is integrated via n8n workflows, document them here]

Workflow NameWorkflow IDPurposeTrigger
[Name][ID][Purpose][Trigger type]

See tools/n8n.md for complete workflow documentation.

Scripts and Automation​

[Document any scripts, backups, or automation related to this tool]

Location: scripts/resources/[tool-name]/

Available Scripts​

  • backup.sh - [Description]
  • export.sh - [Description]
  • sync.py - [Description]

See scripts/resources/[tool-name]/README.md for script documentation.

Troubleshooting​

Common Issues​

Issue: [Problem description]
Solution: [How to fix it]

Issue: [Problem description]
Solution: [How to fix it]

TODO​

  • [Task 1]
  • [Task 2]
  • [Task 3]

[Add links to related tools here]

Note Context

Importance Rating: [Critical|High|Medium|Low] - [Brief explanation of why this rating]

Focus Areas for Note:

  • [What should the AI-generated note emphasize?]
  • [Any clarifications needed (future plans vs current state)]
  • [Specific details to include or avoid]

Additional Context:

  • [Any other guidance for AI note generation]

Last Updated: [Date]
Owner: [Team member responsible]
Status: [Active|Testing|Deprecated]