# Docs

- [Composway documentation](/docs): Reference and guides for connecting to Composway and working with its data.
- MCP server: Connect Composway to Claude Code, Claude, Cursor, VS Code, Codex, Zed, ChatGPT and other MCP clients.
  - [Composway MCP server](/docs/mcp): A hosted MCP server that gives your AI assistant Composway's research, search-analytics and content tools.

  - **Getting started**
  - [Connect your assistant](/docs/mcp/connect): Add the Composway MCP server to Claude Code, Claude, Cursor, VS Code, Codex, Zed, ChatGPT or any other MCP client.

  - **Guides**
  - Cookbook: Recipes for the jobs people actually bring to the MCP server: reading a site, diagnosing a drop, prioritizing work, deciding what to write, reporting across sites.
    - [Cookbook](/docs/mcp/cookbook): Recipes for the jobs people bring to the MCP server - each one a tool order that works, and the reading it depends on.

    - **Search performance**
    - [Read a site's search performance](/docs/mcp/cookbook/read-a-site): The baseline read - what a site is doing now, what it was doing before, and which named question to ask next.
    - [Diagnose a traffic drop](/docs/mcp/cookbook/diagnose-a-drop): From "clicks are down" to a named cause per query - and the different action each cause implies.
    - [Turn findings into one work queue](/docs/mcp/cookbook/prioritize-work): Answer "what should I work on" with four kinds of finding priced in a single unit, then drill into the ones you pick.
    - [Decide what to write next](/docs/mcp/cookbook/decide-what-to-write): Two different questions - demand you are visible for and losing, and demand you have no page for at all - asked in the order that keeps them apart.

    - **Brand & competitors**
    - [Get the brand and competitor sets right](/docs/mcp/cookbook/brand-and-competitors): Two small lists that silently decide what several other tools report - worth checking before you trust a branded split or a share of voice.

    - **Reporting**
    - [Report across several sites](/docs/mcp/cookbook/report-across-sites): One assembled report over up to ten sites - which sections to ask for, and the one argument that makes a portfolio total possible.

  - **Reference**
  - [Find the right tool](/docs/mcp/find): Describe what you want to do and get the Composway MCP tools that answer it - filtered by whether they read or write, and by what they cost.
  - Tool reference
    - [Tool reference](/docs/mcp/tools): Every tool the Composway MCP server exposes - 48 in total, generated from the running server's own registry.

    - **Diagnostics**
    - [Get server status](/docs/mcp/tools/get_server_status): Start here.
    - [Get server info](/docs/mcp/tools/get_server_info): Return Composway MCP server freshness metadata: server version, tools schema version, git/deploy metadata, and Worker version metadata when available.
    - [Get tool manifest](/docs/mcp/tools/get_tool_manifest): Return the canonical tool manifest for this running MCP server, including the tools schema version and a SHA-256 hash of each tool input schema.

    - **Workspaces & campaigns**
    - [Search location/language reference](/docs/mcp/tools/search_reference): Resolve a human-readable location or language name into the DataForSEO reference object ({ id, code, isoCode, name }) required by campaign/workspace writes.
    - [Who am I](/docs/mcp/tools/whoami): Return the authenticated user's Kinde claims (sub, email, name).
    - [List workspaces](/docs/mcp/tools/list_workspaces): List the current user's workspaces (id, title).
    - [Get workspace](/docs/mcp/tools/get_workspace): Get a single workspace with its target audiences, products, default location and language, and its campaigns.
    - [Get workspace competitors](/docs/mcp/tools/get_workspace_competitors): The brands this workspace measures itself against in AI answers: the tracked competitors plus, for reference, the workspace's own brand (`selfBrand`, `isSelf: true`).
    - [List campaigns](/docs/mcp/tools/list_campaigns): List the AEO/AI campaigns in a workspace.
    - [Get campaign](/docs/mcp/tools/get_campaign): Get an AEO campaign's detail: SERP snapshot, analysis, brief, and search-intent-classification ids.
    - [Get related questions & pain points](/docs/mcp/tools/get_campaign_related_questions): Get a campaign's related questions and the discovered pain points.
    - [Get entity list](/docs/mcp/tools/get_campaign_entities): Get the extracted entity list for a campaign.
    - [Get latest article draft](/docs/mcp/tools/get_latest_article): Get the latest user-generated content (article draft + meta tags) for a campaign - the input for evaluate_article, optimize_article, and quick_save.
    - [Deep research](/docs/mcp/tools/deep_research): Perform deep research on how people ask on a related topic.
    - [Get evaluation/optimization result](/docs/mcp/tools/get_evaluation_result): Poll an evaluate_article or optimize_article background job by its jobId.
    - [Get task status](/docs/mcp/tools/get_task_status): Poll the status of a long-running analysis task by the domain record it is linked to (e.g.

    - **Search analytics**
    - [List Search Console + Bing Webmaster sites](/docs/mcp/tools/list_sites): Live: lists every Google Search Console property and Bing Webmaster Tools site visible to the caller's connected accounts, tagged with searchEngine, and joined to the workspace each is already attached to (workspaceId is null when a site i…
    - [Get search-engine connection status](/docs/mcp/tools/get_connection_status): Live: connected Google + Bing accounts, the property/site attached to this site's workspace, and the last time its search data synced.
    - [Get site performance snapshot](/docs/mcp/tools/get_site_snapshot): Summarizes a site's overall Google + Bing search performance over a window and compares it with the immediately preceding window of the same length.
    - [Get site performance trend](/docs/mcp/tools/get_performance_trend): Daily, weekly, or monthly Google + Bing performance trend for a site.
    - [Find new and lost keywords](/docs/mcp/tools/find_new_and_lost_keywords): Query-level `/breakdown` rows classified per engine as new, lost, improved, declined, or stable between the current window and the immediately preceding one of the same length.
    - [Find cross-engine performance gaps](/docs/mcp/tools/find_cross_engine_gaps): Queries or pages where Google and Bing performance diverge materially in the current window.
    - [Find low-hanging keywords](/docs/mcp/tools/find_low_hanging_keywords): High-impression queries ranking just off page one, with an estimated click uplift if promoted to the site's own page-one (`pos1_3`) CTR - built from the site's own current-window rows, not an industry benchmark.
    - [Find CTR opportunities](/docs/mcp/tools/find_ctr_opportunities): Queries or pages whose actual CTR falls well below what the site's own position-based CTR curve predicts for their rank.
    - [Find content gaps](/docs/mcp/tools/find_content_gaps): Two halves under one name, labelled per row.
    - [Get the queries one page ranks for](/docs/mcp/tools/get_page_queries): The queries a specific page drew impressions and clicks for, per engine, over the window.
    - [Get the pages that rank for one query](/docs/mcp/tools/get_query_pages): The pages of the site that surfaced for a specific query, per engine, over the window.
    - [Detect keyword cannibalization](/docs/mcp/tools/detect_keyword_cannibalization): Queries more than one of the site's own pages competes for, read from two sources.
    - [Find decaying pages or queries](/docs/mcp/tools/find_content_decay): Pages or queries in *sustained* decline across several whole periods - not a window-over-window drop, which cannot tell a decline from a bad month.
    - [Find emerging keywords](/docs/mcp/tools/find_emerging_keywords): Queries with sustained or accelerating growth over several whole periods - find_content_decay's classifier with the sign flipped.
    - [Diagnose traffic losses](/docs/mcp/tools/diagnose_traffic_losses): For the queries that lost the most clicks, says *why* - and each cause implies a different action, so the class matters more than the number.
    - [Analyze site sections](/docs/mcp/tools/analyze_site_sections): Aggregates Google + Bing page performance into URL directories (the leading `sectionDepth` path segments) and compares each section's current total against the immediately preceding period.
    - [Analyze branded vs non-branded search](/docs/mcp/tools/analyze_branded_vs_nonbranded): Splits the window's Google + Bing queries into branded and non-branded demand and reports each side's clicks, impressions, CTR, average position and share of the engine's total.
    - [Get workspace brand terms](/docs/mcp/tools/get_workspace_brand_terms): The brand terms a workspace matches queries and AI answers against: `brandTerms` is the effective list (title plus confirmed aliases) and is what analyze_branded_vs_nonbranded and find_low_hanging_keywords actually use.
    - [Score SEO opportunities](/docs/mcp/tools/score_seo_opportunities): One prioritized queue over four tools that each answer a different question: find_low_hanging_keywords, find_ctr_opportunities, find_content_decay and find_content_gaps.
    - [Generate search performance report](/docs/mcp/tools/generate_search_performance_report): A Google + Bing performance report for one site or several, assembled by calling the other tools and embedding their responses whole - so a section here is the same answer the tool gives on its own, and you can read it the same way, `unsup…
    - [Run a custom search-analytics query](/docs/mcp/tools/get_advanced_search_analytics): The composable read: you choose the grouping, filters, sort and limit instead of asking one of the named questions above.

    - **Writes**
    - [Create workspace](/docs/mcp/tools/create_workspace): Create a new workspace.
    - [Create AI campaign](/docs/mcp/tools/create_ai_campaign): Create an AEO (AI) campaign in a workspace from one or more target prompts.
    - [Confirm search intent](/docs/mcp/tools/confirm_search_intent): Confirm the chosen search-intent classification for a campaign.
    - [Confirm pain points](/docs/mcp/tools/confirm_pain_points): Confirm the campaign background: the selected pain points, target audiences, and search-intent ids.
    - [Attach target AI prompt](/docs/mcp/tools/attach_target_ai_prompt): Attach a new target AI prompt (topic + location + language + LLM providers) to a campaign.
    - [Evaluate article](/docs/mcp/tools/evaluate_article): Start an asynchronous evaluation job for an article in a campaign.
    - [Optimize article](/docs/mcp/tools/optimize_article): Start an asynchronous optimization job for an article in a campaign.
    - [Quick save article](/docs/mcp/tools/quick_save): Save an article draft (and meta tags) to a specific user-generated-content version of a campaign.
    - [Set workspace brand terms](/docs/mcp/tools/set_workspace_brand_terms): Add, remove, or replace a workspace's confirmed brand aliases.
    - [Set workspace competitors](/docs/mcp/tools/set_workspace_competitors): Add, edit, or stop tracking the competitors a workspace is measured against in AI answers.
    - [Explain a query's SERP](/docs/mcp/tools/explain_query_serp): Fetch this query's Google SERP **live** and diff it against the newest SERP stored for this workspace.

  - **Help**
  - [Troubleshooting](/docs/mcp/troubleshooting): The failures people actually hit - stalled calls, missing confirmations, empty results - and what each one means.