|
| 1 | +--- |
| 2 | +sidebar_class_name: hidden |
| 3 | +title: AGENTS.md - AI Documentation Maintenance Guide |
| 4 | +--- |
| 5 | + |
| 6 | +# AGENTS.md - AI Documentation Maintenance Guide |
| 7 | + |
| 8 | +This is a hidden guide for AI agents to understand how to maintain and update the AI interfaces documentation in Port Docs. |
| 9 | + |
| 10 | +## File Structure |
| 11 | + |
| 12 | +The AI interfaces documentation files are located in: |
| 13 | +- `/docs/ai-interfaces/` - Main documentation files |
| 14 | +- `/src/data/mcpTools.js` - MCP tool definitions (JSON file) |
| 15 | +- `/src/components/ToolsList/` - React component that displays tools from `mcpTools.js` |
| 16 | + |
| 17 | +## Common Tasks |
| 18 | + |
| 19 | +### Update MCP Tools |
| 20 | + |
| 21 | +To add, update, or remove MCP tools: |
| 22 | + |
| 23 | +1. **Update the file**: `src/data/mcpTools.js` |
| 24 | +2. **Ask for clarification**: Determine if the tool is for `builder` only or for both `developer` and `builder` roles |
| 25 | +3. The `ToolsList` component automatically reads from this file and displays tools in the documentation |
| 26 | + |
| 27 | +### Set Feature Beta Status |
| 28 | + |
| 29 | +When asked to mark a feature as **open beta** or **closed beta**, use the appropriate component: |
| 30 | + |
| 31 | +#### For Open Beta Features |
| 32 | + |
| 33 | +Use the `BetaFeatureNotice` component: |
| 34 | + |
| 35 | +```markdown |
| 36 | +import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md' |
| 37 | + |
| 38 | +<BetaFeatureNotice id="ai-form" /> |
| 39 | +``` |
| 40 | + |
| 41 | +**Location**: Place this after the page title (H1) and before the main content. |
| 42 | + |
| 43 | +#### For Closed Beta Features |
| 44 | + |
| 45 | +Use the `ClosedBetaFeatureNotice` component: |
| 46 | + |
| 47 | +```markdown |
| 48 | +import ClosedBetaFeatureNotice from '/docs/generalTemplates/_closed_beta_feature_notice.md' |
| 49 | + |
| 50 | +<ClosedBetaFeatureNotice id="feature-id" /> |
| 51 | +``` |
| 52 | + |
| 53 | +**Location**: Place this after the page title (H1) and before the main content. |
| 54 | + |
| 55 | +**ID**: Use a specific feature identifier (e.g., `"slack-app"`). Check `/docs/generalTemplates/_closed_beta_feature_notice_defs.js` for available IDs and their custom messages. You might need to create a new definition, ask the user for this. |
| 56 | + |
| 57 | +### Add New LLM Model |
| 58 | + |
| 59 | +To add a new LLM model to the documentation: |
| 60 | + |
| 61 | +1. **Identify the model name and providers**: Determine the exact model identifier (e.g., `gpt-5`) and which providers support it (e.g., Anthropic, AWS Bedrock). |
| 62 | + |
| 63 | +2. **Update the main documentation file**: Edit `docs/ai-interfaces/port-ai/llm-providers-management/overview.md`: |
| 64 | + |
| 65 | +3. **Note about API reference files**: The API reference files in `docs/api-reference/` (like `general-purpose-ai-interactions.api.mdx`, `invoke-a-specific-agent.api.mdx`, etc.) are auto-generated from OpenAPI specifications. These will be updated automatically when the backend API is updated. You don't need to manually edit these files. |
| 66 | + |
| 67 | +### Update MCP Installation Instructions |
| 68 | + |
| 69 | +The MCP installation instructions are maintained in a reusable component that is imported into the main documentation page. |
| 70 | + |
| 71 | +**Location**: `/docs/generalTemplates/_mcp-installation.md` |
| 72 | + |
| 73 | +**Usage**: This component is imported in `docs/ai-interfaces/port-mcp-server/overview-and-installation.md`. |
| 74 | + |
| 75 | +**What you could update**: |
| 76 | +- Add new client support |
| 77 | +- Update client instructions |
| 78 | +- Update disclaimers/warnings/admonitions |
| 79 | + |
| 80 | +### Update Feature Support Matrix |
| 81 | + |
| 82 | +The Feature Support Matrix table shows which capabilities are supported across Port's AI interfaces. |
| 83 | + |
| 84 | +**Location**: `docs/ai-interfaces/overview.md` - in the "Feature Support Matrix" section |
| 85 | + |
| 86 | +**Structure**: |
| 87 | +- **Rows**: Each Port AI interface (Port MCP Server, Port AI Invocation, Port AI Agents, Port AI Chat Widget, Port Slack App, Port AI Assistant) |
| 88 | +- **Columns**: Capabilities/features (Context Lake Query, Run Actions, Manage Blueprints, etc.) |
| 89 | +- **Indicators**: |
| 90 | + - ✅ = Supported |
| 91 | + - ❌ = Not supported |
| 92 | + |
| 93 | +**Column Ordering Rules**: |
| 94 | +1. **First columns**: Features that have at least one ✅ (supported by at least one interface) |
| 95 | +2. **Last columns**: Features that have all ❌ (not supported by any interface) |
| 96 | +3. **Final column**: "Manage Data Mapping" should always be the last column (it has all ❌) |
| 97 | + |
| 98 | +**Current column order** (from first to last): |
| 99 | +1. Feature (row identifier) |
| 100 | +2. Context Lake Query |
| 101 | +3. Run Actions |
| 102 | +4. Manage Blueprints |
| 103 | +5. Manage Entities |
| 104 | +6. Manage Scorecards |
| 105 | +7. Manage Actions |
| 106 | +8. Reuse Prompts |
| 107 | +9. Invoke AI Agents |
| 108 | +10. Manage Pages & Widgets (all ❌) |
| 109 | +11. Manage Integrations (all ❌) |
| 110 | +12. Manage Data Mapping (all ❌ - must be last) |
| 111 | + |
| 112 | +**When updating**: |
| 113 | +- If a new feature is added that has all ❌, add it before "Manage Data Mapping" (which must remain last) |
| 114 | +- If a feature's support status changes from all ❌ to having at least one ✅, move it to the appropriate position in the first group |
| 115 | +- If a new AI interface is added, add it as a new row |
| 116 | +- If a new capability is added, determine its position based on whether it has any ✅ or all ❌ |
| 117 | + |
| 118 | +**Format**: |
| 119 | +- Use markdown table format |
| 120 | +- Wrap the table in `<div style={{overflowX: 'auto'}}>` for horizontal scrolling on smaller screens |
| 121 | +- Use emojis ✅ and ❌ (not text symbols) |
| 122 | + |
| 123 | +### Update Monthly Limits |
| 124 | + |
| 125 | +When asked to update the monthly quota/limit for AI invocations: |
| 126 | + |
| 127 | +1. **Identify all locations**: Search for mentions of monthly limits/quota in the AI interfaces documentation: |
| 128 | + - `docs/ai-interfaces/port-ai/api-interaction.md` - Contains rate limits section and example JSON responses |
| 129 | + - `docs/ai-interfaces/port-ai/overview.md` - Contains limits section and FAQ entries |
| 130 | + |
| 131 | +2. **Update text descriptions**: Replace the quota number in all text descriptions (e.g., "20 AI invocations per month" → "50 AI invocations per month") |
| 132 | + |
| 133 | +3. **Update example JSON**: Update the `monthlyLimit` value in example JSON responses to match the new limit. Also update `remainingQuota` to be one less than the limit (e.g., if limit is 50, remainingQuota should be 49) |
| 134 | + |
| 135 | +4. **Files to check**: |
| 136 | + - `docs/ai-interfaces/port-ai/api-interaction.md` - Lines with "Monthly Quota" section and JSON examples |
| 137 | + - `docs/ai-interfaces/port-ai/overview.md` - Lines with "Monthly Quota" section and FAQ entries |
| 138 | + |
| 139 | +5. **Search pattern**: Look for patterns like: |
| 140 | + - "20 AI invocations per month" |
| 141 | + - `"monthlyLimit": 20` |
| 142 | + - "Default quota: 20" |
| 143 | + |
| 144 | +**Note**: The API reference files in `docs/api-reference/` are auto-generated from OpenAPI specifications and will be updated automatically when the backend API is updated. You don't need to manually edit these files. |
| 145 | + |
| 146 | +## Other Tasks |
| 147 | + |
| 148 | +For other tasks not listed above, ask for clarification from the user. Once understood, add a new section to the "Common Tasks" section of this file. |
0 commit comments