Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
BEACONED_API_KEYYesYour API key for the Beaconed API. Get it at https://beaconed.ai under Settings > API Keys.
BEACONED_BASE_URLNoBase URL for the Beaconed API. Useful for local dev or staging.https://beaconed.ai

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}
resources
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
beaconed_products_listA

GET /api/v1/products — list products with optional filters for status, score, grade, and search query

beaconed_products_getB

GET /api/v1/products/{id} — fetch full product detail including images, score history, and latest optimization

beaconed_products_scoresC

GET /api/v1/products/{id}/scores — fetch score history for a specific product

beaconed_products_optimizationsB

GET /api/v1/optimizations?product_id={id} — list optimizations for a specific product

beaconed_optimizations_listB

GET /api/v1/optimizations — list AI-generated optimizations with optional filters for status, field, product, and date

beaconed_optimizations_getA

GET /api/v1/optimizations/{id} — fetch full optimization detail including original and optimized content

beaconed_scores_listA

GET /api/v1/scores — list readiness scores across all products (SPEC-ABSENT endpoint; verify availability with API team)

beaconed_scores_latestC

GET /api/v1/scores/latest — fetch the latest score for each product (SPEC-ABSENT endpoint; verify availability with API team)

beaconed_settings_getA

GET /api/v1/settings — fetch the account optimization settings including brand voice, required/excluded keywords, and auto-push configuration

beaconed_webhooks_listB

GET /api/v1/webhooks — list webhook subscriptions registered for the current API key

beaconed_webhooks_getA

GET /api/v1/webhooks/{id} — fetch details about a specific webhook subscription including last error info

beaconed_webhooks_eventsA

GET /api/v1/webhooks/events — fetch the global catalog of all available webhook event types

beaconed_products_createA

POST /api/v1/products — create a product from external (non-Shopify) data. Use external_id for idempotency.

beaconed_products_updateA

PATCH /api/v1/products/{id} — update a product's fields. Only include fields you want to change.

beaconed_products_syncA

POST /api/v1/products/{id}/sync — trigger a Shopify sync for the product (queued, 202). EXPENSIVE: 10 req/min limit.

beaconed_products_optimizeA

POST /api/v1/products/{id}/optimization — queue AI optimization for one or more product fields (queued, 202). EXPENSIVE: 10 req/min limit.

beaconed_products_calculate_scoreA

POST /api/v1/products/{id}/scores/calculation — recalculate the readiness score for a product. EXPENSIVE: 10 req/min limit.

beaconed_optimizations_approveA

POST /api/v1/optimizations/{id}/approval — approve a pending optimization, marking it ready to apply. EXPENSIVE: 10 req/min limit.

beaconed_optimizations_rejectA

POST /api/v1/optimizations/{id}/rejection — reject a pending optimization with an optional reason.

beaconed_optimizations_applyA

POST /api/v1/optimizations/{id}/application — applies an approved optimization to the live product. DESTRUCTIVE: changes the product's public-facing copy. EXPENSIVE: 10 req/min limit.

beaconed_optimizations_revertA

POST /api/v1/optimizations/{id}/reversion — reverts an applied optimization back to the original content. DESTRUCTIVE: overwrites the product's current copy. EXPENSIVE: 10 req/min limit.

beaconed_webhooks_createA

POST /api/v1/webhooks — create a new webhook subscription. The signing secret is returned only once — store it securely.

beaconed_webhooks_updateA

PATCH /api/v1/webhooks/{id} — update a webhook subscription's URL, events, or status.

beaconed_webhooks_deleteA

DELETE /api/v1/webhooks/{id} — permanently remove a webhook subscription. DESTRUCTIVE: webhook deliveries stop immediately.

beaconed_webhooks_testA

POST /api/v1/webhooks/{id}/test — send a test event to a webhook to verify delivery is working.

beaconed_bulk_optimizeA

POST /api/v1/bulk_optimizations — queue AI optimization for multiple products in one request (queued, 202). EXPENSIVE: 10 req/min limit.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription
beaconed-products-listPaginated list of Beaconed products (first page, 20 per page)
beaconed-optimizations-listPaginated list of Beaconed optimizations (first page, 20 per page)

TDQS

B3.4/5.0

Scored across 26 tools

Disambiguation4/5

Most tools map cleanly to a resource and action, but a few boundaries are blurry: beaconed_products_optimizations and beaconed_optimizations_list both return optimizations (one filtered by product), and beaconed_products_get includes score history alongside beaconed_products_scores. These are workable but could cause occasional misselection.

Naming Consistency3/5

All names share the beaconed_ prefix and use snake_case, which helps, but the action pattern is inconsistent: most list operations use '_list' except beaconed_products_optimizations and beaconed_scores_latest, and noun/subresource ordering varies (products_scores vs scores_list). The naming is readable but not uniform.

Tool Count2/5

At 26 tools, the server is above the 25+ threshold and feels heavy for a single product-optimization domain. The webhook sub-surface alone accounts for 7 tools, and several product/optimization/score listing endpoints could be consolidated.

Completeness4/5

The optimization lifecycle (list/get/approve/reject/apply/revert) and webhook lifecycle (CRUD/test/events) are well covered, and score history plus latest scores are available. Obvious gaps are a settings update endpoint (only settings_get exists) and product deletion, but agents can still complete core workflows.

Maintenance

ActivityMaintained
ResponsivenessUnresponsive