Skip to main content
Glama

Get Integration Guide

get_integration_guide
Read-onlyIdempotent

Read the Bridge integration guide for a topic — the supported, opinionated way to consume Bridge from application code. Call this BEFORE writing or changing app code that reads a feature flag, renders billing or team UI, or wires authentication, and before hand-rolling anything against the SDK: the SDKs ship declarative surfaces for these cases (components, route guards, decorators) and reimplementing them against SDK internals is the most common integration mistake. Per-framework topics (framework REQUIRED): integration (first-time setup) | auth | feature-flags | billing | team | branding. Framework-agnostic MASTER topics (framework is IGNORED — omit it): master, the end-to-end auth integration prompt served by bridge guide, which orchestrates project discovery and then routes to the per-framework guides; flags-master and billing-master, the same orchestration for a flags-only or billing-only integration; mechanisms, how limits, upgrades and customization work; orientation, what Bridge does (the same map get_started returns); fit-together, how roles, plans, limits and flags fit together; integration-success, the message to show the developer when an integration is done. Before setting up flags, roles, plans or limits, read topic=fit-together. Start at topic=master when integrating Bridge into a project for the first time. framework: svelte | react | angular | nextjs | nestjs | express — pass the one the target app actually uses; this server cannot detect it. Returns the guide as markdown plus its source URL. Guidance is a default, not a mandate — follow the user's stated preference when it differs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appNoId of the Bridge app to act on for this call (see list_apps). Omit to use the current app.
topicYesWhich guide to read. Use orientation for what Bridge does, master for a first-time end-to-end integration, flags-master/billing-master for a flags-only or billing-only one, mechanisms for how limits, upgrades and customization work, fit-together for how roles, plans, limits and flags fit together (read it before setting any of those up), integration-success for the message to show when an integration is done. Use feature-flags after changing a flag, billing after changing a plan/price/quota, team after changing roles/tenants/invites, auth after changing login methods, SSO or redirect URIs, branding after changing the app's look.
frameworkNoThe framework the target application uses. Required for the per-framework topics (integration, auth, feature-flags, billing, team, branding) — the server has no way to infer it from the request. Ignored for the master topics, mechanisms, orientation, fit-together and integration-success, which are framework-agnostic.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds real behavioral context beyond them: it returns markdown plus a source URL, the server cannot detect the framework, master topics ignore the framework and orchestrate routing to per-framework guides, and 'guidance is a default, not a mandate'. This is unusually rich disclosure for a read-only tool.

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?

Front-loaded with purpose and usage, which is good, but the topic catalogue is restated almost verbatim in both the description and the schema enum descriptions, and the paragraph runs long with heavy parenthetical chaining. Information-dense but not efficiently sized.

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?

Complete for a read-only guide lookup: no output schema exists, and the description still discloses the return format (markdown + source URL), the topic taxonomy, the framework requirement rules, and cross-topic sequencing. Nothing an agent needs to call 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 coverage is 100%, so the baseline is 3, but the description adds meaning the enum list does not: the master-vs-per-framework distinction (framework REQUIRED vs IGNORED), the orchestration role of master/flags-master/billing-master, and the 'pass the one the target app actually uses; this server cannot detect it' constraint on framework.

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 ('Read the Bridge integration guide for a topic') and immediately frames its scope as the opinionated consumption path, which distinguishes it from siblings like diagnose_integration or scaffold_flags_integration. An agent can tell what it returns and why it exists without opening the schema.

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?

Explicitly prescribes when to call it ('BEFORE writing or changing app code that reads a feature flag, renders billing or team UI, or wires authentication') and warns against the alternative (hand-rolling against SDK internals). Adds sequencing rules ('Start at topic=master when integrating for the first time', 'read topic=fit-together before setting up flags/roles/plans/limits').

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.