Skip to main content
Glama

osirSiteDesignBrief

Read-onlyIdempotent

osirSiteDesignBrief: Step 1 of designing a NEW website with OSIR. Validates the brief and returns 'systemPrompt', the structured design brief and constraints YOU must then follow to write one complete self-contained HTML page, plus 'editRules' for later revisions. Call it before osirSitePublish for a new site, then publish the finished page with osirSitePublish. No authentication needed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageJobYesThe page's single job: get_contact, sell_product, book_appointment, collect_signups, inform_portfolio, or other.
audienceYesWho visits the site and why.
whatItIsYesWhat the business concretely does or sells.
briefJsonNoOptional JSON object with extras the user provided: site_type, sections[], language (ISO code, default en), tone (warm|premium|playful|technical|minimal|bold), mood_words[] (max 5), brand{logo_url, primary_color '#RRGGBB', secondary_color, fonts[], existing_site_url, references[{url, what_you_like}] (max 3; direction only, never copied), dislikes}, content{tagline, services_or_products[{name,description,price}], about_text, contact{phone,email,address,hours,social[]}, image_urls[], testimonials[{quote,name}] (real only)}, constraints{dark_mode, animations (none|subtle|expressive), form_endpoint, legal_footer}. Ask the user rather than inventing values; skipped extras are fine.
businessNameYesThe business or project name.
primaryActionYesThe one primary call to action, e.g. 'Book a table'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / properties / audience / description
      Added value: +"Who visits the site and why."
    • addedInput schema / properties / briefJson / description
      Added value: +"Optional JSON object with extras the user provided: site_type, sections[], language (ISO code, default en), tone (warm|premium|playful|technical|minimal|bold), mood_words[] (max 5), brand{logo_url, primary_color '#RRGGBB', secondary_color, fonts[], existing_site_url, references[{url, what_you_like}] (max 3; direction only, never copied), dislikes}, content{tagline, services_or_products[{name,description,price}], about_text, contact{phone,email,address,hours,social[]}, image_urls[], testimonials[{quote,name}] (real only)}, constraints{dark_mode, animations (none|subtle|expressive), form_endpoint, legal_footer}. Ask the user rather than inventing values; skipped extras are fine."
    • addedInput schema / properties / businessName / description
      Added value: +"The business or project name."
    • addedInput schema / properties / pageJob / description
      Added value: +"The page's single job: get_contact, sell_product, book_appointment, collect_signups, inform_portfolio, or other."
    • addedInput schema / properties / primaryAction / description
      Added value: +"The one primary call to action, e.g. 'Book a table'."
    • addedInput schema / properties / whatItIs / description
      Added value: +"What the business concretely does or sells."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

The description discloses that the tool validates the brief, returns structured instructions, and requires no authentication. Annotations already provide readOnlyHint and idempotentHint, and the description is consistent with those, adding context about the returned artifacts and the follow-up responsibility to write the HTML page.

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 dense paragraph with no filler. Every sentence contributes: the tool's role, what it returns, the exact sequence with osirSitePublish, and the authentication posture. It is front-loaded with the primary purpose and maintains clarity.

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 the tool's complexity and the fact that there is no output schema, the description usefully names the two return artifacts ('systemPrompt' and 'editRules') and states the next step. It does not detail the format of those artifacts, but for a step-initiating tool that hands off a prompt, the described handoff is sufficient.

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 description coverage is 100%, so the individual parameters are already well documented in the input schema. The description adds no per-parameter semantics beyond indicating that the brief is validated, but the schema descriptions, especially for briefJson, carry the load.

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 states a specific verb (validates, returns), the resource (new OSIR site design brief), and positions it as Step 1 in a two-step flow with osirSitePublish. It distinguishes the tool from its sibling by naming the concrete outputs ('systemPrompt', 'editRules') rather than just restating the name.

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?

The description explicitly tells the agent to call this before osirSitePublish for a new site and then publish the finished page with that tool. It clearly conveys when in the workflow to use it, though it does not discuss when not to use it or alternatives beyond the named sibling.

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.