Skip to main content
Glama
Opedd

Opedd

Official

Place a licence order

place_licence_order

Place a licence order for one or more publishers by choosing licence, billing mode, and quantity; returns order lines, access key, and hosted invoice URL for payment.

Instructions

Place a licence order with Opedd for one or more publishers. One order = one licence and one billing mode; each publisher becomes its own Schedule priced from that publisher's settings (publishers that do not offer it are returned in unavailable and never charged). Licences: 'enterprise' (AI answers: 'monthly' full text per article, or 'metered' pay per answer, read through search_passages only; self-serve buyers need no order for this, the licence created when they add a card at sign-up already covers every publisher offering a per-answer price), 'archive' (Full catalogue: everything the publisher published up to the order date, kept permanently, not for AI training: 'one_time', full text in the feed), 'training' (AI training of the back catalogue up to the order date: 'one_time', bulk export via stream_feed_ndjson), 'display' (client display: 'monthly', quantity = number of end clients). A monthly AI answers subscription only covers articles published from the day it starts; set include_archive=true on a 'enterprise' + 'monthly' order to add each publisher's Full catalogue in the same order (complete access). Returns the order, its lines, the access key (works once paid) and hosted_invoice_url — the buyer (your principal) pays there. Requires a buyer session (OPEDD_BUYER_JWT) and terms_accepted=true after the buyer has accepted the Opedd Master Services Agreement (opedd.com/terms).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
licenceYesenterprise = AI answers, archive = Full catalogue (everything published up to the order date, kept permanently, no AI training), training = AI training, display = client display
quantityNodisplay only: number of end clients (1-500)
billing_modeYesenterprise: monthly | metered; archive: one_time; training: one_time; display: monthly
publisher_idsYesPublisher UUIDs (1-500; at most 18 for metered)
terms_acceptedYesREQUIRED. Set true only after the buyer has accepted the Opedd Master Services Agreement at opedd.com/terms. The current version label is recorded with the order; orders without genuine acceptance are rejected.
include_archiveNoOptional, monthly AI answers only (licence 'enterprise' + billing_mode 'monthly'). true adds each publisher's Full catalogue to the same order: everything published before the order date, kept permanently, not for AI training. Publishers that do not sell their Full catalogue are returned in `unavailable`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.6.8

TDQS

A4.5/5.0
Behavior5/5

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

Annotations declare write/non-idempotent/non-destructive, and the description adds substantial context beyond them: requires a buyer session (OPEDD_BUYER_JWT) and genuine terms_accepted=true per the MSA, returns the access key (only valid once paid) and hosted_invoice_url where the buyer pays, and guarantees non-offering publishers appear in `unavailable` and are never charged. This is exactly the kind of auth, payment, and failure-mode disclosure the annotations cannot convey.

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

Conciseness3/5

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

Purpose and cardinality are front-loaded, but the body is a dense run-on packed with nested parentheticals covering four licence modes and cross-references, making it hard to scan. Most sentences carry needed detail, but the structure could be broken up and the description is close to over-length.

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 6-parameter, multi-mode order tool with no output schema, it covers return contents (order, lines, access key, hosted_invoice_url), auth prerequisites, terms acceptance, and edge cases (unavailable publishers, monthly coverage window). Nothing essential to calling it correctly 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?

Schema description coverage is 100%, so the baseline is 3; the description adds interpretive value by explaining valid licence/billing_mode combinations and the monthly-answers temporal caveat ('only covers articles published from the day it starts'). It reinforces include_archive and quantity semantics but mostly duplicates what the schema already documents.

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?

States a specific verb and resource ('Place a licence order with Opedd for one or more publishers') and immediately scopes the cardinality ('one order = one licence and one billing mode'). It clearly distinguishes itself from list_licence_orders, purchase_license, and verify_license by describing order creation with per-publisher Schedules.

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 strong conditional guidance: self-serve buyers need no order for enterprise/per-answer pricing, include_archive is only for 'enterprise' + 'monthly', and each licence/billing_mode pairing is enumerated. It names related siblings (search_passages, stream_feed_ndjson) as context but never explicitly contrasts when to choose this tool over purchase_license or list_licence_orders.

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