DataForSEO MCP Server

Instructions

Implementation Reference

• src/core/modules/backlinks/tools/backlinks-competitors.tool.ts:75-92 (handler)

  The handle method implements the core logic of the backlinks_competitors tool, making a POST request to the DataForSEO Backlinks Competitors API endpoint and processing the response.

  async handle(params: any): Promise<any> {
    try {
      const response = await this.client.makeRequest('/v3/backlinks/competitors/live', 'POST', [{
        target: params.target,
        limit: params.limit,
        offset: params.offset,
        filters: this.formatFilters(params.filters),
        order_by: this.formatOrderBy(params.order_by),
        main_domain: params.main_domain,
        exclude_large_domains: params.exclude_large_domains,
        exclude_internal_backlinks: params.exclude_internal_backlinks
      }]);
      return this.validateAndFormatResponse(response);
  
    } catch (error) {
      return this.formatErrorResponse(error);
    }
  }

• src/core/modules/backlinks/tools/backlinks-competitors.tool.ts:18-73 (schema)

  Defines the Zod schema for input parameters of the backlinks_competitors tool.

    getParams(): z.ZodRawShape {
      return {
        target: z.string().describe(`domain, subdomain or webpage to get backlinks for
          required field
  a domain or a subdomain should be specified without https:// and www.
  a page should be specified with absolute URL (including http:// or https://)`),
        limit: z.number().min(1).max(1000).default(10).optional().describe("the maximum number of returned domains"),
        offset: z.number().min(0).optional().describe(
          `offset in the results array of returned networks
  optional field
  default value: 0
  if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages`
        ),
        filters: z.array(
          z.union([
            z.array(z.union([z.string(), z.number(), z.boolean()])).length(3),
            z.enum(["and", "or"])
          ])
        ).max(8).optional().describe(
          `array of results filtering parameters
  optional field
  you can add several filters at once (8 filters maximum)
  you should set a logical operator and, or between the conditions
  the following operators are supported:
  regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
  you can use the % operator with like and not_like to match any string of zero or more characters
  example:
  ["rank",">","100"]
  [["target","like","%forbes%"],
  "and",
  [["rank",">","100"],"or",["intersections",">","5"]]]`
        ),
        order_by: z.array(z.string()).optional().describe(
          `results sorting rules
  optional field
  you can use the same values as in the filters array to sort the results
  possible sorting types:
  asc – results will be sorted in the ascending order
  desc – results will be sorted in the descending order
  you should use a comma to set up a sorting type
  example:
  ["rank,desc"]
  note that you can set no more than three sorting rules in a single request
  you should use a comma to separate several sorting rules
  example:
  ["intersections,desc","rank,asc"]`
        ),
        main_domain: z.boolean().optional().describe(`indicates if only main domain of the target will be included in the search
  if set to true, only the main domain will be included in search`).default(true),
        exclude_large_domains: z.boolean().optional().describe(`indicates whether large domain will appear in results
  if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted`).default(true),
        exclude_internal_backlinks: z.boolean().optional().describe(`indicates if internal backlinks from subdomains to the target will be excluded from the results
  if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
  if set to false, internal links will be included in the results`).default(true)
      };
    }

• src/core/modules/backlinks/backlinks-api.module.ts:29-62 (registration)

  Registers the BacklinksCompetitorsTool (line 39) among other tools in the BacklinksApiModule's getTools method, mapping it by name with description, params, and handler.

  getTools(): Record<string, ToolDefinition> {
    const tools = [
      new BacklinksTool(this.dataForSEOClient),
      new BacklinksAnchorTool(this.dataForSEOClient),
      new BacklinksBulkBacklinksTool(this.dataForSEOClient),
      new BacklinksBulkNewLostReferringDomainsTool(this.dataForSEOClient),
      new BacklinksBulkNewLostBacklinksTool(this.dataForSEOClient),
      new BacklinksBulkRanksTool(this.dataForSEOClient),
      new BacklinksBulkReferringDomainsTool(this.dataForSEOClient),
      new BacklinksBulkSpamScoreTool(this.dataForSEOClient),
      new BacklinksCompetitorsTool(this.dataForSEOClient),
      new BacklinksDomainIntersectionTool(this.dataForSEOClient),
      new BacklinksDomainPagesSummaryTool(this.dataForSEOClient),
      new BacklinksDomainPagesTool(this.dataForSEOClient),
      new BacklinksPageIntersectionTool(this.dataForSEOClient),
      new BacklinksReferringDomainsTool(this.dataForSEOClient),
      new BacklinksReferringNetworksTool(this.dataForSEOClient),
      new BacklinksSummaryTool(this.dataForSEOClient),
      new BacklinksTimeseriesNewLostSummaryTool(this.dataForSEOClient),
      new BacklinksTimeseriesSummaryTool(this.dataForSEOClient),
      new BacklinksBulkPagesSummaryTool(this.dataForSEOClient),
      new BacklinksFiltersTool(this.dataForSEOClient)
      // Add more tools here
    ];
  
    return tools.reduce((acc, tool) => ({
      ...acc,
      [tool.getName()]: {
        description: tool.getDescription(),
        params: tool.getParams(),
        handler: (params: any) => tool.handle(params),
      },
    }), {});
  }

• src/core/modules/backlinks/tools/backlinks-competitors.tool.ts:10-12 (handler)

  Returns the tool name 'backlinks_competitors' used for registration and identification.

  getName(): string {
    return 'backlinks_competitors';
  }

• src/core/modules/backlinks/tools/backlinks-filters.tool.ts:32-32 (helper)

  Maps the tool name to its filter path 'competitors' in the available filters tool.

  'backlinks_competitors': 'competitors'