Create competitor set

create_competitor_set Explicitly approve one customer and up to ten competitors. Set registration is available while discovery admission is disabled. Registration does not verify links or buy discovery.

Hosted MCP registration verified. These schemas describe the development contract; confirm supported inputs with tools/list. Generic CLI/HTTP calls require a matching development server. Configure LINKTRAIL_API_URL; production does not expose these command routes.

Access	Behavior
`discovery:write`	Writes or admits work

Reading saved data does not start a verification job. Mutations can change saved records or access; the effects below apply.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_competitor_set",
    "arguments": {
      "projectId": "project_example",
      "approved": true,
      "members": [
        {
          "role": "customer",
          "scope": {
            "target_kind": "domain",
            "target": "example.com",
            "include_subdomains": true
          }
        },
        {
          "role": "competitor",
          "scope": {
            "target_kind": "domain",
            "target": "competitor.example.com",
            "include_subdomains": true
          }
        }
      ]
    }
  }
}

linktrail call create_competitor_set --args '{"projectId":"project_example","approved":true,"members":[{"role":"customer","scope":{"target_kind":"domain","target":"example.com","include_subdomains":true}},{"role":"competitor","scope":{"target_kind":"domain","target":"competitor.example.com","include_subdomains":true}}]}'

curl "$LINKTRAIL_API_URL/v1/commands/create_competitor_set" \
  -H "Authorization: Bearer $LINKTRAIL_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"projectId":"project_example","approved":true,"members":[{"role":"customer","scope":{"target_kind":"domain","target":"example.com","include_subdomains":true}},{"role":"competitor","scope":{"target_kind":"domain","target":"competitor.example.com","include_subdomains":true}}]}'

Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

{
  "v": 1,
  "id": "cs_example",
  "revision": 1,
  "workspace_id": "ws_example",
  "project_id": "project_example",
  "approved_by": "user_example",
  "approved_at": "2026-09-13T12:00:00.000Z",
  "members": [
    {
      "role": "customer",
      "scope": {
        "target_kind": "domain",
        "target": "example.com",
        "include_subdomains": true
      },
      "id": "cm_customer"
    },
    {
      "role": "competitor",
      "scope": {
        "target_kind": "domain",
        "target": "competitor.example.com",
        "include_subdomains": true
      },
      "id": "cm_competitor"
    }
  ],
  "current_revision": 1,
  "retired_at": null
}

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Field	Type	Presence	Meaning and constraints
`projectId`	string	Required	Identifier of the project returned by its create or list operation. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`approved`	boolean	Required	Explicit approval required to freeze this customer and competitor selection. must equal true
`members`	array	Required	Customer and competitor members approved for this set revision. minItems: 2; maxItems: 11
`members[].role`	string	Required	See the typed schema and response example for this field. values: “customer”, “competitor”
`members[].scope`	object	Required	See the typed schema and response example for this field. additional fields rejected
`members[].scope.target_kind`	string	Required	See the typed schema and response example for this field. values: “domain”, “exact_url”
`members[].scope.target`	string	Required	See the typed schema and response example for this field. minLength: 1; maxLength: 4096
`members[].scope.include_subdomains`	boolean	Required	See the typed schema and response example for this field.

Validation and omitted values

Requires exactly one customer, distinct member identities and nonoverlapping approved target scopes. Scope target kind, target and subdomain policy are explicit; none is inferred from a default.

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.

Field	Type	Presence	Meaning and constraints
`v`	number	Required	v recorded for this result. must equal 1
`id`	string	Required	Resource identifier returned by the operation. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`revision`	integer	Required	revision recorded for this result. minimum: 1; maximum: 9007199254740991
`workspace_id`	string	Required	Workspace that owns this record. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`project_id`	string	Required	Project that owns this record. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`approved_by`	string	Required	approved by recorded for this result. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`approved_at`	string	Required	approved at recorded for this result. format: “date-time”; pattern: ”^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$“
`members`	array	Required	members recorded for this result. minItems: 2; maxItems: 11
`members[].id`	string	Required	Resource identifier returned by the operation. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`members[].role`	string	Required	role recorded for this result. values: “customer”, “competitor”
`members[].scope`	object	Required	scope recorded for this result. additional fields rejected
`members[].scope.target_kind`	string	Required	target kind recorded for this result. values: “domain”, “exact_url”
`members[].scope.target`	string	Required	target recorded for this result. minLength: 1; maxLength: 4096
`members[].scope.include_subdomains`	boolean	Required	include subdomains recorded for this result.
`current_revision`	number	Required	current revision recorded for this result.
`retired_at`	string / null	Required	retired at recorded for this result.

Download input schema · Download output schema

Errors and retries

This command is not annotated idempotent. After a timeout, inspect existing state before repeating a write. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See HTTP route details.

Method and route	Success	Details
`POST /v1/competitor-sets`	201	Remaining arguments go in a JSON object body.

Continue

get_competitor_set · request_competitor_inventory Follow the related workflow, inspect capability status, or return to the command index.

Overview

Cloud operations

Repository tools

HTTP and events

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue

​Example request

​Returned result

​Input fields

​Validation and omitted values

​Output fields

​Errors and retries

​HTTP resource routes

​Continue

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue