MCP Server / guide 4 of 19

MCP Server Quickstart

The ActorConsole Model Context Protocol (MCP) server lets AI tools like Claude Code, Cursor, or Codex inspect and manage your Apify actors. Create the key while the intended workspace is selected; every MCP request remains permanently limited to that workspace.

1. Run the MCP package

Run in terminal

# From this repository while the package is unpublished
pnpm --filter @actorconsole/mcp dev

# After publishing
npx -y @actorconsole/mcp

2. Set Environment Variables

Environment

# Required: a Pro MCP credential from Dashboard → MCP access
ACTORCONSOLE_API_KEY=al_your_mcp_credential
API_BASE_URL=https://actorconsole.com/api

3. Add to Claude Code Config

Claude Code config

{
  "mcpServers": {
    "actorconsole": {
      "command": "npx",
      "args": ["-y", "@actorconsole/mcp"],
      "env": {
        "ACTORCONSOLE_API_KEY": "al_your_mcp_credential",
        "API_BASE_URL": "https://actorconsole.com/api"
      }
    }
  }
}

4. Hosted HTTP clients

Connect to the hosted /mcp endpoint and send the same workspace credential as a Bearer token. Each client supplies its own credential; the server does not use a shared MCP secret.

HTTP headers

Authorization: Bearer al_your_mcp_credential
Content-Type: application/json

Codex configuration

Codex config.toml

[mcp_servers.actorconsole]
command = "npx"
args = ["-y", "@actorconsole/mcp"]

[mcp_servers.actorconsole.env]
ACTORCONSOLE_API_KEY = "al_your_mcp_credential"
API_BASE_URL = "https://actorconsole.com/api"

Cursor can use the same JSON MCP server entry shown for Claude Code.

Complete registered tool list

get_workspaceget_mcp_capabilitiesget_mcp_usagelist_actorsget_actorlist_published_actorslist_maintenance_actorslist_deprecated_actorslist_unpublished_actorslist_publish_ready_actorssync_actorslist_notificationsget_unread_notification_countmark_notification_readmark_all_notifications_readanalyze_actorrewrite_actor_title_descriptionrewrite_actor_readmerewrite_actor_listinggenerate_actor_schemascreate_actor_optimization_runget_actor_optimization_runapply_actor_changesget_actor_change_statusredesign_readme_from_filesget_pricingset_pricingrecommend_pricingget_pricing_historysearch_actorskeyword_competitorsget_usage_costsget_actor_performanceget_actor_revenueget_workspace_usageget_workspace_revenueget_usage_historychange_actor_store_statuslist_actor_status_operationsget_actor_status_operationlist_publishing_schedulesget_publishing_schedulecreate_publishing_scheduleupdate_publishing_scheduleadd_actors_to_publishing_scheduleremove_actors_from_publishing_schedulepause_publishing_scheduleresume_publishing_schedulerun_publishing_schedulelist_publishing_runsget_publishing_runrequeue_publishing_actor

Resources

actorconsole://workspace
actorconsole://actors
actorconsole://actors/{actorId}
actorconsole://notifications
actorconsole://publishing/schedules

Prompts

optimize_actor_listing
redesign_actor_readme
triage_maintenance_actors
prepare_publishing_schedule
review_deprecated_actors

Example tool request

{
  "name": "list_actors",
  "arguments": {
    "status": "maintenance",
    "page": 1,
    "limit": 25,
    "readiness": "needs-attention"
  }
}

// Response content contains the cached page, total count,
// synchronization timestamp, and Actor status metadata.

Previous guideSet Up Your First Workspace Next guideMCP Configuration Reference

Need more help? Contact supportGet started free

{ "mcpServers": { "actorconsole": { "command": "npx", "args": ["-y", "@actorconsole/mcp"], "env": { "ACTORCONSOLE_API_KEY": "al_your_mcp_credential", "API_BASE_URL": "https://actorconsole.com/api" } } } }

[mcp_servers.actorconsole] command = "npx" args = ["-y", "@actorconsole/mcp"] [mcp_servers.actorconsole.env] ACTORCONSOLE_API_KEY = "al_your_mcp_credential" API_BASE_URL = "https://actorconsole.com/api"

Complete registered tool list

{ "name": "list_actors", "arguments": { "status": "maintenance", "page": 1, "limit": 25, "readiness": "needs-attention" } } // Response content contains the cached page, total count, // synchronization timestamp, and Actor status metadata.