Skip to main content
Glama

Weekly Report

report_weekly
Read-onlyIdempotent

Compare weekly revenue and order changes, analyze customer segments, identify trending products, and receive AI-generated insights.

Instructions

Weekly trend report: revenue/order changes vs previous week, customer segment distribution, trending products, and AI-generated insights.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
store_idYesUUID of a connected store (returned by store_connect with action="connect" or visible in store_connect with action="list" / the store_overview resource)

Implementation Reference

  • Zod schema defining the WeeklyReport return type with fields: store_id, week_start/end, total_orders, total_revenue, avg_order_value, revenue/order change percent, top_segments, trending_products, insights, and summary.
    export const WeeklyReportSchema = z.object({
      store_id: z.string().uuid(),
      week_start: z.string(),
      week_end: z.string(),
      total_orders: z.number().int(),
      total_revenue: z.number(),
      avg_order_value: z.number(),
      revenue_change_percent: z.number(),
      order_change_percent: z.number(),
      top_segments: z.array(z.object({
        segment: RFMSegmentSchema,
        count: z.number().int(),
        revenue: z.number(),
      })),
      trending_products: z.array(z.object({
        title: z.string(),
        units_change: z.number().int(),
        trend: z.enum(['rising', 'stable', 'declining']),
      })),
      insights: z.array(z.string()),
      summary: z.string(),
    });
    export type WeeklyReport = z.infer<typeof WeeklyReportSchema>;
Behavior3/5

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

Annotations already indicate read-only, non-destructive, idempotent behavior. The description adds context about AI-generated insights but does not detail data freshness, authorization requirements, or return format. No contradiction with annotations.

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

Conciseness5/5

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

The description is a single, efficient sentence that conveys all necessary information without redundancy. It is front-loaded with the core purpose and lists specific components.

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?

Given a single parameter, no output schema, and moderate complexity, the description covers the report's contents well. It could mention that it compares to the previous week, but overall it is sufficiently complete.

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?

The input schema has one parameter (store_id) with a comprehensive description (100% coverage). The description does not add further parameter meaning beyond what the schema provides, so a baseline score of 3 is appropriate.

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 produces a weekly trend report covering revenue/order changes, customer segments, trending products, and AI insights. It uses specific verbs and resources, distinguishing it from siblings like report_daily.

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

Usage Guidelines3/5

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

The description implies usage for generating weekly reports but does not explicitly state when to use this tool versus alternatives (e.g., report_daily). No exclusions or prerequisites are mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/enzoemir1/shopops-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server