|
| 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., `haiku-4.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 | +## Other Tasks |
| 68 | + |
| 69 | +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