Skip to main content
Glama

Detalhe da campanha

get_campaign
Read-only

Detalhe de uma campanha (por id ou slug) com os grupos e o resumo dos últimos 7 e 30 dias: cliques, entradas, saídas, retenção, vendas e comissão. "cliques" soma o clique em oferta de quem já está no canal ou grupo; quem clicou no link de entrada é "cliques_entrada". A taxa de entrada, com a mesma janela nos dois números, está em campaign_metrics. Use quando o usuário perguntar sobre UMA campanha específica ("como está a campanha X?").

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id_ou_slug": "<id_ou_slug>"
    },
    "name": "get_campaign"
  }
}

Input Schema

NameRequiredDescriptionDefault
id_ou_slugYesID da campanha (cmp_…) ou o slug do link personalizado.

Output Schema

NameRequiredDescriptionDefault
resumoNo
successNo
campanhaNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered; the description adds real value beyond that by defining what 'cliques' counts (offer clicks by people already in the channel/group) versus 'cliques_entrada' (entry-link clicks) and by stating the 7- and 30-day windows. It also notes where the entry rate lives (campaign_metrics), which prevents misuse of this tool's numbers.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The payload is front-loaded in the first sentence, followed by the metric-definition caveat and then the usage trigger — a logical order. The metric definitions are dense but each earns its place; nothing is padded, though the metric paragraph could be tightened slightly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a single required parameter, full schema coverage, an output schema, and safety annotations, the only burden left is semantic — and the description covers the metric meanings and windows well. It is slightly short on lookup failure behavior and on explicitly naming the sibling to use for listing or aggregate metrics.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single parameter already documents 'cmp_…' IDs and slug values, so the schema carries the load. The description only restates 'por id ou slug' without adding format, validation, or fallback behavior (e.g., what happens if the slug is ambiguous), so this stays at the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Detalhe de uma campanha') plus the lookup key (id ou slug) and the payload it returns (grupos, resumo de 7/30 dias com cliques, entradas, saídas, retenção, vendas e comissão). It is clearly not a listing tool, but it never names list_campaigns, so differentiation from the sibling that enumerates campaigns is only implied.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit trigger: 'Use quando o usuário perguntar sobre UMA campanha específica ("como está a campanha X?")'. This cleanly separates it from aggregate/listing siblings, but there is no when-not-to-use clause or pointer to the alternative (list_campaigns for enumeration, campaign_metrics for cross-campaign metrics).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources