Skip to documentation
Browse documentation

Ask Hyran from your AI assistant

Connect Claude, ChatGPT, Codex or another approved MCP client to the planning information your team already manages in Hyran Brand. Planners can ask questions in business language and receive a tenant-scoped, read-only answer from the same capability catalogue used by Ask Hyran.

The production connection is https://api.data.hyran.co/mcp. The demo connection is https://api.demo.data.hyran.co/mcp.

What planners can ask

Materials and commitments

  • Where does open demand exceed our greige commitment?
  • Show greige, colour and direct-colour commitments for this SKU.
  • Which materials need attention, and why?
  • What changed in this SKU's commitment history since the last review?
  • Which material positions disagree with expected consumption?

Forecast and planning cycles

  • What is the current netted forecast for this date, style or SKU?
  • Which commitment cycles are locked, reviewed or still open?
  • What changed after the latest forecast or commitment upload?
  • Compare two planning scenarios and explain the important differences.
  • Which key dates create the next decision deadline?

Suppliers and purchase orders

  • Which supplier positions no longer cover the plan?
  • Which supplier reports are stale or incomplete?
  • Show confirmed purchase orders for this supplier and date range.
  • Where do purchase orders leave uncovered demand?
  • Which materials and suppliers are associated with this style or SKU?

Exceptions, evidence and investigation

  • What needs attention before the next planning review?
  • Why did this commitment position change?
  • Which open findings have the greatest planning impact?
  • When was this information last updated?
  • Show the source record, calculation and change history behind this answer.

An empty result means only that no matching record was returned for the requested filters and time. It does not prove that a SKU is inactive, discontinued, never ordered or managed outside Hyran. Check freshness, identifiers and source evidence before drawing that conclusion.

Read-only capability catalogue

The connector and Ask Hyran resolve through one shared capability catalogue. Tool availability can be reduced by organisation and client policy, but a client cannot create a new capability or select a different organisation through its request.

Planning jobAvailable capabilities
Find and inspectFind SKUs and materials; get SKU, style, material and supplier details; search and inspect connected records
Review commitmentsReview commitments, material commitments, supplier commitments, supplier positions and SKU commitment history
Understand the planReview the netted forecast, key dates, commitment-cycle locks, purchase orders and material-to-factory positions
Investigate changeReview the change log and upload history; investigate a planning change; compare planning scenarios
Prioritise attentionReview open findings; explain material attention and commitment variance; prioritise planning exceptions
Check trustList connected information, check freshness and inspect source evidence
Investigate raw recordsQuery approved Brand record families with bounded filters, stable ordering, opaque cursors and page limits

Every public Brand capability is read-only and idempotent. The connector does not expose SQL, database credentials, arbitrary joins, caller-selected organisations or approval and commitment actions.

Connect an enterprise AI workspace

EnvironmentSupported connection pathAdministrator control
ChatGPT EnterprisePrivate workspace app using a custom MCP connectionAdministrators review, publish and control workspace access
Claude EnterpriseOrganisation connector using remote MCPOrganisation owners add the connector and users sign in individually
Microsoft 365 CopilotFederated connector using MCPMicrosoft 365 administrators govern approved connectors and user access
Gemini EnterpriseCustom MCP server data storeGoogle Cloud administrators configure the connection and authorisation

Support and availability change across provider plans and release channels. Confirm the current provider requirements before customer rollout.

Data retention and stringent controls

Hyran's connection controls and the AI provider's processing controls are separate. Hyran can enforce read-only access, user and organisation scope, source-system permissions, audit correlation and bounded responses. The selected AI environment controls how prompts, retrieved information and model responses are processed and retained after they leave Hyran.

Do not infer zero data retention from an enterprise product name. Provider programmes have separate eligibility, configuration and feature exclusions:

  • OpenAI describes zero data retention as an approved control for qualifying API organisations and projects. ChatGPT workspace retention has its own product controls and terms.
  • Anthropic states that its zero data retention agreements apply to the Anthropic API and products using the customer's commercial API key unless the customer agreement explicitly says otherwise.
  • Google Cloud documents the configuration needed to achieve zero data retention on Vertex AI, including features that retain data and must be avoided or configured separately.
  • Microsoft documents that Microsoft 365 Copilot federated connectors retrieve information in real time without indexing the external data into Microsoft 365. Microsoft's enterprise data protection and customer terms govern the resulting Copilot interaction.

For a stringent deployment, record the exact provider product, region, model endpoint, retention setting, logging destinations, caching features, connector path and contractual terms. Hyran should describe a deployment as zero retention only after those controls and terms have been verified for that customer.

Sign in

Add the production or demo MCP URL to the approved client. The client opens Hyran's sign-in page. After sign-in, Hyran verifies the user, organisation, client policy and requested read scope before it returns the permitted capabilities.

For Codex, add the Hyran Data plugin from the approved marketplace, then run:

codex mcp login hyran-data --oauth-client-registration dcr

Complete sign-in and organisation selection in the browser. Start a new task after the client has been approved for the organisation.

Verify the connection

After sign-in:

  1. Confirm the client shows Hyran Data as connected.
  2. Ask, "What Hyran information can I access?"
  3. Ask, "When was the connected Brand information last updated?"
  4. Search for a known SKU or material reference.
  5. Request one bounded, paginated list and follow its next-page cursor.
  6. Remove the connection and confirm that a new request requires sign-in again.

If the client reports no capabilities, remove the connection and add it again. If authorisation fails, send the provider reference ID and the approximate time to Hyran support. Do not send an access token.

Protocol example

Use this only when testing an already-issued OAuth access token at the protocol boundary:

curl --request POST https://api.data.hyran.co/mcp \
  --header "Authorization: Bearer $HYRAN_DATA_OAUTH_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json, text/event-stream" \
  --data '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2025-06-18",
      "capabilities": {},
      "clientInfo": { "name": "customer-integration", "version": "1.0.0" }
    }
  }'