# CrowTerminal — how to use (mcp.ai)

Connect your CrowTerminal account and use 27 tools for developer tools straight from your AI agent. Connect with your own API key. AI-powered command line assistant with memory and automation capabilities for developers.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_crowterminal?ms=1787295960000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `crowterminal_analyze_engagement`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/crowterminal`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/crowterminal/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/crowterminal/analyze/engagement` — Tool to analyze engagement correlation for every field in your agent's markdown. Use when you need to understand which agent configuration fields drive engagement and get specific recommendations for 
  - body: { agent_md: object, client_id: string }
- `POST https://api.mcp.ai/api/crowterminal/compare/md` — Tool to compare your agent's markdown directly with all stored versions. Returns field differences showing which values differ across versions, lists missing fields not present in your current data, a
  - body: { agentMd: object, clientId: string }
- `POST https://api.mcp.ai/api/crowterminal/create/webhook` — Tool to register a new webhook for receiving real-time event notifications from CrowTerminal. Use when you need to set up asynchronous notifications for events like skill updates, data ingestion, or v
  - body: { url: string, events: string[], secret?: string }
- `POST https://api.mcp.ai/api/crowterminal/delete/webhook` — Tool to delete an existing webhook registration. Use when you need to remove a webhook that is no longer needed or should be replaced.
  - body: { webhook_id: string }
- `POST https://api.mcp.ai/api/crowterminal/get/byok/platform/intel` — Tool to get algorithm insights for TikTok, Instagram, and YouTube without client-specific context. Use when you need platform intelligence data for BYOK (Bring Your Own Key) analysis workflows. This e
- `POST https://api.mcp.ai/api/crowterminal/get/client/memory/changelog` — Retrieve human-readable change history for a client's memory. Provides a narrative view of how the client's skill data has evolved over time.
  - body: { client_id: string }
- `POST https://api.mcp.ai/api/crowterminal/get/client/memory/pattern` — Tool to track a specific field over time for trend analysis. Use when you need to understand how a particular metric evolved across versions or time periods.
  - body: { field?: string, client_id: string }
- `POST https://api.mcp.ai/api/crowterminal/get/components/status` — Tool to get detailed status of each CrowTerminal service component. Returns current health status, latency, and summary statistics for all monitored components (database, cache, APIs, webhooks). Use w
- `POST https://api.mcp.ai/api/crowterminal/get/data/types` — Tool to retrieve valid data types for ingestion across platforms. Returns available data types for TikTok, Instagram, and YouTube that can be used for data ingestion operations.
- `POST https://api.mcp.ai/api/crowterminal/get/incidents` — Tool to retrieve list of recent incidents from CrowTerminal with duration and affected components. Use when you need to check system status, monitor service health, or investigate recent outages or de
- `POST https://api.mcp.ai/api/crowterminal/get/platform/intel` — Tool to retrieve algorithm insights for TikTok, Instagram, and YouTube. Returns platform-wide intelligence about content algorithm behavior and optimization strategies. Use when you need current platf
- `POST https://api.mcp.ai/api/crowterminal/get/sandbox/client` — Tool to get mock client data for testing in the sandbox environment. Use when you need to test client-related functionality without affecting real data. No authentication required for sandbox endpoint
- `POST https://api.mcp.ai/api/crowterminal/get/sandbox/memory` — Tool to retrieve mock memory/skill data for testing purposes. Use when you need to test memory retrieval without affecting real data or requiring authentication. Part of the sandbox testing environmen
- `POST https://api.mcp.ai/api/crowterminal/get/status` — Retrieve CrowTerminal service status including overall health, component metrics, and uptime data. Use when you need to check the operational status of CrowTerminal services or monitor system health. 
- `POST https://api.mcp.ai/api/crowterminal/get/status/history` — Tool to get 7-day uptime data points ready for visualization and charting. Use when you need historical uptime metrics for monitoring dashboards or status displays.
- `POST https://api.mcp.ai/api/crowterminal/get/uptime` — Tool to retrieve historical uptime data for CrowTerminal agents. Use when you need to check system reliability, view uptime percentages for 24h/7d periods, or review recent service incidents.
- `POST https://api.mcp.ai/api/crowterminal/ingest/bulk/data` — Tool to bulk ingest up to 50 analytics data points at once to CrowTerminal. Use when you need to efficiently push large amounts of platform analytics data for content creators across social media plat
  - body: { items: object[] }
- `POST https://api.mcp.ai/api/crowterminal/ingest/data` — Tool to ingest platform analytics data from TikTok Studio, Instagram Insights, or YouTube Analytics. Use when you need to push retention curves, demographics, traffic sources, or other engagement metr
  - body: { data: object, videoId?: string, clientId: string, dataType: string, platform: string, confidence?: number }
- `POST https://api.mcp.ai/api/crowterminal/list/webhooks` — Tool to list all registered webhooks for the authenticated agent. Use when you need to view all webhook subscriptions and their configurations.
- `POST https://api.mcp.ai/api/crowterminal/ping/crowterminal` — Tool to check CrowTerminal service availability via a simple ping endpoint. Use when you need to verify the service is online and responding. Returns a pong confirmation with a timestamp.
- `POST https://api.mcp.ai/api/crowterminal/read/bulk/memory` — Tool to read memory for multiple clients at once (up to 50). Use when you need to efficiently retrieve memory data for multiple creators in a single API call.
  - body: { clientIds: string[] }
- `POST https://api.mcp.ai/api/crowterminal/register/agent` — Tool to self-register a new agent and obtain an API key. Use when you need to create a new agent identity in CrowTerminal. No authentication required for this endpoint. Rate limited to 5 requests per 
  - body: { agentName: string, agentDescription?: string }
- `POST https://api.mcp.ai/api/crowterminal/run/sandbox/engagement/analysis` — Tool to run mock engagement analysis in the CrowTerminal sandbox environment. Use when you need to test the engagement analysis workflow without affecting real data or when developing and validating a
  - body: { agentMd: object }
- `POST https://api.mcp.ai/api/crowterminal/test/webhook` — Tool to test a webhook URL by sending a test payload. Use when you need to verify that a webhook endpoint is properly configured and can receive requests.
  - body: { url: string, secret?: string }
- `POST https://api.mcp.ai/api/crowterminal/update/webhook` — Tool to update an existing webhook configuration in CrowTerminal. Use when you need to modify webhook URL, change event subscriptions, or enable/disable a webhook.
  - body: { url?: string, events?: string[], is_active?: boolean, webhook_id: string }
- `POST https://api.mcp.ai/api/crowterminal/validate/proposed/changes` — Tool to validate proposed changes against historical data before updating memory. Use when you need to check if proposed changes contradict historical patterns and receive warnings or recommendations.
  - body: { clientId: string, proposedChanges: object[] }
- `POST https://api.mcp.ai/api/crowterminal/validate/sandbox` — Tool to mock validation endpoint for testing in sandbox. Use when you need to test validation logic. Send 'tutorial' in proposedChanges to get a blocked response.
  - body: { proposedChanges: string[] }

## Example prompts
- "What can I do in CrowTerminal?"
- "Show me a summary of my CrowTerminal account"

## More
- Page: https://mcp.ai/crowterminal
- Agent spec (llms.txt): https://mcp.ai/crowterminal/llms.txt
- Postman collection: https://mcp.ai/crowterminal/postman.json