Partner Onboarding Kit β FrootAI Integration Guide
> For Partners: ServiceNow, Salesforce, SAP, Datadog, PagerDuty, Jira, and other enterprise platforms. > This guide walks you through creating a FrootAI community plugin that connects your platform to the FAI ecosystem.
What Is a Community Plugin?
A community plugin bundles FrootAI primitives (agents, skills, instructions, hooks) to integrate your platform with AI solution plays. When users install your plugin, they get pre-built AI capabilities for your platform β wired into the FAI Protocol.
Examples already built:
community-plugins/servicenow/β IT ticket classification, routing, resolution via ServiceNow MCPcommunity-plugins/salesforce/β CRM integration, lead scoring, pipeline AIcommunity-plugins/sap/β ERP integration, procurement AI, supply chain
Plugin Structure
community-plugins/
βββ your-platform/
βββ plugin.json # Required β plugin manifest
βββ README.md # Required β install guide + architecture
βββ agents/ # Optional β platform-specific agents
β βββ your-agent.agent.md
βββ skills/ # Optional β platform-specific skills
β βββ your-skill/
β βββ SKILL.md
βββ instructions/ # Optional β platform-specific coding standards
β βββ your-platform.instructions.md
βββ hooks/ # Optional β platform-specific lifecycle hooks
βββ your-hook/
βββ hooks.json
βββ script.shStep 1: Create plugin.json
{
"name": "your-platform",
"description": "FrootAI integration for YourPlatform β [what it does]",
"version": "1.0.0",
"author": {
"name": "Your Company",
"url": "https://yourplatform.com"
},
"license": "MIT",
"keywords": ["your-platform", "integration", "mcp", "enterprise"],
"plays": ["05-it-ticket-resolution", "54-ai-customer-support-v2"],
"primitives": {
"agents": ["agents/your-agent.agent.md"],
"skills": ["skills/your-skill/"],
"instructions": ["instructions/your-platform.instructions.md"],
"hooks": []
},
"mcp": {
"tools": ["your_platform_search", "your_platform_create", "your_platform_update"],
"transport": "stdio"
},
"requirements": {
"node": ">=18",
"apiAccess": "YourPlatform API key or OAuth2 credentials"
}
}Required Fields
| Field | Type | Description |
|---|---|---|
name | string | Kebab-case, matches folder name |
description | string | 10-1024 characters |
version | string | Semver (e.g., 1.0.0) |
author.name | string | Company or individual name |
license | string | Must be MIT for community plugins |
Optional but Recommended
| Field | Type | Description |
|---|---|---|
plays | string[] | Which solution plays this plugin enhances |
keywords | string[] | Search/discovery terms |
mcp.tools | string[] | MCP tool names your plugin exposes |
Step 2: Create Platform Agent
Create agents/your-platform-agent.agent.md:
---
description: "AI agent for YourPlatform β [primary capability]"
tools: ["your_platform_search", "your_platform_create"]
waf: ["security", "reliability", "operational-excellence"]
plays: ["05-it-ticket-resolution"]
---
# YourPlatform AI Agent
You are an expert in YourPlatform integration. You help users:
- Search and retrieve records from YourPlatform
- Create and update records via API
- Map YourPlatform data to FrootAI solution play schemas
- Follow YourPlatform API best practices and rate limits
## Authentication
Always use OAuth2 or managed credentials. Never hardcode API keys.
## Rate Limiting
Respect YourPlatform API limits: [specify limits]
## Error Handling
On 429 (rate limit): exponential backoff with jitter
On 401 (auth): prompt for credential refresh
On 5xx: retry with circuit breaker (3 attempts, 30s cooldown)Step 3: Create README.md
Your README should include:
- What it does β 2-3 sentence summary
- Prerequisites β API access, credentials, versions
- Installation β
npx frootai install your-platform - Configuration β Environment variables, OAuth setup
- Compatible Plays β Which solution plays it enhances
- MCP Tools β What tools it adds to the MCP server
- Architecture β How data flows between FrootAI and your platform
- Examples β Real usage scenarios
Step 4: Test & Validate
# Validate plugin structure
npm run validate:primitives
# Check JSON syntax
node -e "require('./community-plugins/your-platform/plugin.json')"
# Verify agent frontmatter
# (description 10+ chars, name kebab-case)Step 5: Submit PR
- Fork github.com/frootai/frootaiΒ
- Create branch:
feat/community-plugin-your-platform - Add your plugin to
community-plugins/your-platform/ - Run validation:
npm run validate:primitives - Submit PR using the PR TemplateΒ
PR Checklist for Partners
-
plugin.jsonhas all required fields -
README.mdexists with installation instructions - No hardcoded API keys or secrets
- All file names use lowercase-hyphen convention
- Agent files have valid YAML frontmatter (description 10+ chars)
- Tested with at least one compatible solution play
- License is MIT
Existing Partner Plugins
| Partner | Folder | Plays | MCP Tools | Status |
|---|---|---|---|---|
| ServiceNow | community-plugins/servicenow/ | 05, 37, 54 | ticket_search, ticket_create, ticket_update | β Active |
| Salesforce | community-plugins/salesforce/ | 54, 59, 64 | lead_search, opportunity_update, contact_create | β Active |
| SAP | community-plugins/sap/ | 55, 89 | procurement_search, inventory_check, order_create | β Active |
Partner Benefits
- Marketplace Listing: Your plugin appears in the FAI MarketplaceΒ (77+ plugins)
- Search Index: Discoverable via the website search (3,346 entries)
- MCP Integration: Your tools are accessible from Claude, Copilot, Cursor, Windsurf
- Solution Play Wiring: Users get your integration automatically when they init a compatible play
- VS Code Extension: Your plugin appears in the VS Code sidebar Primitives view
- Community Visibility: Listed on the Partners pageΒ
Support
- Documentation: frootai.dev/docsΒ
- Community: frootai.dev/communityΒ
- Contribute: frootai.dev/contributeΒ
- Issues: github.com/frootai/frootai/issuesΒ
- Discussions: github.com/frootai/frootai/discussionsΒ
Last updated on