Skip to content

docs: add agent onboarding page#2369

Open
lukas-bekr wants to merge 1 commit intoapify:masterfrom
lukas-bekr:add-agent-onboarding-page
Open

docs: add agent onboarding page#2369
lukas-bekr wants to merge 1 commit intoapify:masterfrom
lukas-bekr:add-agent-onboarding-page

Conversation

@lukas-bekr
Copy link

@lukas-bekr lukas-bekr commented Mar 25, 2026

Summary

  • Adds an agent onboarding page at /platform/integrations/agent-onboarding
  • Entry point for developers and AI agents connecting to Apify
  • Covers all integration methods: MCP server, Agent Skills, API client, CLI, REST API
  • Includes FAQ section optimized for agent consumption
  • API quick reference table with key endpoints including the sync run-sync-get-dataset-items shortcut

Relationship to #2367

This is an alternative take on the same problem as #2367 by @nicoleolender. Key differences:

This PR #2367
Includes Agent Skills section Missing skills coverage
FAQ section (optimized for agent parsing) No FAQ
apify-client vs apify naming trap warning Not covered
MCP Configurator link (mcp.apify.com) Not covered
Lighter on CLI/API code examples More detailed curl examples

Both PRs share the same signpost/hub-and-spoke philosophy - link out to detailed docs rather than duplicate content. The best version is probably a merge of both. Happy to consolidate into one.

Structure

  1. Core concepts intro (Actors, Datasets, API)
  2. Prerequisites (account, token, free exploration tip)
  3. Integration methods (MCP > Skills > API client > CLI > REST API)
  4. Documentation access for agents (.md URLs, Accept: text/markdown, MCP tools)
  5. FAQ (5 questions covering common agent confusion points)
  6. Useful resources (links to CLI, API, client libs, storage, academy)

Context

Test plan

  • Page renders correctly in Docusaurus preview (npm start)
  • All internal links resolve (no broken links)
  • Tabs component works for JS/Python code examples
  • Admonitions render with correct titles
  • npm run lint:md passes

🤖 Generated with Claude Code


Note

Low Risk
Low risk documentation-only change that adds a new onboarding page; the main risk is broken links or incorrect setup instructions for MCP/Skills/API usage.

Overview
Adds a new platform/integrations/agent-onboarding doc page that serves as an entry point for connecting AI agents/apps to Apify.

The page documents multiple integration paths (remote/local MCP server setup, Agent Skills install, JS/Python apify-client examples, CLI usage, and a REST API quick-reference including run-sync-get-dataset-items), plus guidance on programmatic docs access and an agent-friendly FAQ/resources section.

Written by Cursor Bugbot for commit b19a982. Configure here.

@lukas-bekr lukas-bekr requested a review from TC-MO as a code owner March 25, 2026 00:37
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is kicking off a free cloud agent to fix this issue. This run is complimentary, but you can enable autofix for all future PRs in the Cursor dashboard.

Comment @cursor review or bugbot run to trigger another review on this PR

sidebar_label: Agent onboarding
description: Connect your AI agent to Apify. Set up the MCP server, install Agent Skills + CLI, or integrate via the API client.
sidebar_position: 0
slug: platform/integrations/agent-onboarding
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slug format causes incorrect URL path resolution

High Severity

The slug value platform/integrations/agent-onboarding is missing a leading / and incorrectly includes the platform/ prefix. Every other doc in this directory uses an absolute slug pattern like /integrations/crewai. Since the Docusaurus docs plugin already sets routeBasePath: 'platform', this relative slug gets resolved against the file's directory, producing a deeply nested and incorrect URL instead of the intended /platform/integrations/agent-onboarding. The correct slug is /integrations/agent-onboarding.

Fix in Cursor Fix in Web

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bugbot Autofix determined this is a false positive.

The file mentioned in the bug report (agent-onboarding.md with slug 'platform/integrations/agent-onboarding') does not exist; the actual file is ai-agents.md with correct slug '/integrations/ai-agents', and git history shows all versions always had correct slug format with leading slash.

This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants