Skip to main content
Glama
PROMPTEYE-SP-Z-O-O

prompteye-mcp

Official

How to wire a website into public reports

get_report_integration
Read-only

Get the agency ID, endpoint, and example request for integrating public reports into a website form. Provides a ready-to-hand cURL snippet for developers.

Instructions

Everything a developer needs to post a form on the agency's own site straight to public reports: the agency id, the endpoint, a filled-in example body, a cURL line and the request typed out. A public report is PromptEye's lead magnet, sold to agencies white-label: a prospect fills in a form on the agency's site, PromptEye works out the industry, asks a set of assistants how visible that brand is, and emails back a page in the agency's branding — a visibility score, the competitors ahead of them, and quotes from what the assistants actually said. It is a one-off sample, not tracking: nothing is measured again until the report is converted into a project, which happens in the PromptEye app. leadStatus and the conversion are the agency's sales pipeline, and contactCount is how many times the brand asked to be contacted from the page.

Call this whenever the question is how to set up, configure or integrate public reports, what the agency id is or where to find it, or what to hand a developer — and hand the answer over as the example, rather than describing it. The agency id is simply the id of the account this API key belongs to; it is what the public endpoint identifies the account by, since the call carries no key. That is also why the snippet is safe in a browser, and why the PromptEye API key must never be put in it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.16

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already include readOnlyHint=true and openWorldHint=true, so the read-only nature is covered. The description adds rich behavioral context: explains the public report as a lead magnet, one-off sample, non-tracking nature, and why the snippet is browser-safe (no API key). This goes beyond the annotations and is highly useful for the agent to understand the tool's role.

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 description is longer than typical but every sentence adds value: it starts with what the tool returns, then explains the business context, then usage guidance. It is front-loaded with the core purpose. While it could be tightened slightly, it is not bloated and the structure aids comprehension.

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

Completeness5/5

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

For a tool with no parameters and no output schema, the description is fully complete. It explains what the output contains (integration example), the context of public reports, when to call, and security implications. Nothing an agent needs to correctly invoke or interpret the tool is missing.

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

Parameters4/5

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

The tool has zero parameters and schema coverage is 100%, so there is nothing for the description to clarify about parameters. The baseline for 0 params is 4, and the description doesn't need to add parameter details. It does explain the output (integration example), which is relevant but not parameter-specific.

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

Purpose5/5

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

The description clearly states the tool provides integration details for posting forms to public reports, including agency id, endpoint, example body, cURL, and request. It explicitly differentiates from siblings by stating 'Call this whenever the question is how to set up, configure or integrate public reports' – distinct from get_report or create_report.

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

Usage Guidelines5/5

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

Provides explicit when-to-use guidance: 'Call this whenever the question is how to set up, configure or integrate public reports, what the agency id is or where to find it, or what to hand a developer.' It also tells the agent to hand over the answer as an example rather than describing it. Clear and actionable.

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