OT Flash Agent- en MCP-integratiehandleiding
Protocollen, autorisatie, toolcontracten en het volledige aanroepproces
Bouw traceerbare data- en kennisapplicaties met de publieke Remote MCP van OT Flash r56. Dit handboek behandelt OAuth, protocolberichten, de parameterreferentie van alle gedeclareerde tools, bewijsregels, voorwaardelijke mogelijkheden en herstelprocedures, en bevat een uitvoerbare client en voorbeelden met synthetische data.
Agent-ontwikkelaars, integratie-engineers en beheerders
De bijbehorende voorbeelden behouden de Chinese weergavenamen van velden. De vertaling van de interface en de toelichtende tekst verandert niets aan de werkelijke tabelnamen, kolomnamen, enumwaarden, toolnamen of protocolvelden.
Inhoudsopgave
- 1Reikwijdte en voltooiingscriteria van de Agent-integratie
- 2Snel verbinden en mogelijkheden ontdekken
- 3OAuth discovery, registratie en autorisatie
- 4Scope, resourcegrenzen en realtime rechten
- 5HTTP- en moderne MCP-berichten
- 6Compatibiliteit met clients van het oude protocol
- 7De juiste tool en het juiste bewijskanaal kiezen
- 8Ontologieresources en id-typen
- 9Doris-tabelquery- en structuurcontract
- 10Multidimensionale Top3 en omgang met afkapping
- 11Kennis zoeken, volledige brontekst en bewijsgeschiktheid
- 12Native Search-model en -sessies
- 13Taal- en regioconventies
- 14Geïntegreerde analyse en interactieve resultaten
- 15Persistente visualisatierapporten en MCP Apps
- 16Artefactconcepten, voorbeeldweergave, plan en toepassing
- 17Ontologiekandidaten maken en publicatiecontract
- 18Gepubliceerde modellen, kandidaatquery's en referentieafsluiting
- 19Ontologie-agenttaken delegeren
- 20MCP voor de Business Workspace
- 21Invoer van bedrijfskennis en te bevestigen vragen
- 22Responsen, fouten en veilig opnieuw proberen
- 23Integratiebeveiliging en grenzen van de mogelijkheden
- 24Beheerdersconfiguratie en voorwaardelijke schakelaars
- 25Uitvoerbare client en aanroepvoorbeelden
- 26Ontologiechatinterface insluiten
- 27Acceptatiechecklist voor integratie
- 28Referentiematerialen en onderhoud
- 29Toolparameterreferentie: basis en native Search
- 30Toolparameterreferentie: tabellen, graaf en kennis
- 31Toolparameterreferentie: analyse en rapporten
- 32Toolparameterreferentie: modellering en oorspronkelijke taken
- 33Toolparameterreferentie: kennisinvoer en bereik
- 34Toolparameterreferentie: Business Workspace
Reikwijdte en voltooiingscriteria van de Agent-integratie
Kies het geautoriseerde toegangspunt en rond query's, bewijsvergaring of gecontroleerde schrijfacties af op basis van ontvangstbewijzen van de server.
OT Flash r56 biedt externe Agents via Remote MCP data- en kennisfuncties binnen het bereik van de ontologie, en biedt daarnaast een afzonderlijk toegangspunt voor de Business Workspace. Een Agent moet het uitvoerbare werk bepalen op basis van de werkelijke tools/list, inputSchema, OAuth scope en de huidige resourcerechten, en mag niet op grond van een statische handleiding aannemen dat een implementatie alle optionele functies heeft ingeschakeld.
| Toegangspunt | Doel | Grenzen |
|---|---|---|
| /mcp | Ontologie, datatabellen, documentkennis, native Search en voorwaardelijk beschikbare analyse en modellering | Het snijpunt van de rechten van de huidige gebruiker en de resources die bij deze autorisatie zijn toegekend |
| /mcp/business | Bedrijfssysteemdetectie, query's, actieplannen, status en uitvoering | Afzonderlijke autorisatie van bedrijfssystemen en gepubliceerde contracten |
| Ingebedde ontologie-agentpagina | Ontologiechat gebruiken in de interface voor mensen | Vereist een echte ingelogde sessie; geen toegangspunt om zonder login MCP-tokens in te wisselen |
Categorieën van mogelijkheden
- Basisleesfuncties: ontologie en resources, lokalisatie in de graaf, kennis zoeken en volledige brontekst, details van geautoriseerde tabellen en Doris SQL.
- Afzonderlijke delegatie: dfc_search vereist search:operate en blijft de oorspronkelijke gebruikers- en modelrechten gebruiken.
- Voorwaardelijk beschikbaar: analyse, persistente rapporten, artefactconcepten en het toepassen ervan, ontologiemodelquery's en gedelegeerde Agent-taken.
- Niet-beschikbare mogelijkheden: de dfc_etl van Flash rapporteert alleen capabilities en biedt geen Heavy ETL-uitvoering. AutoML en het interne toegangspunt van de FocusCode-werkruimte vallen niet onder de publieke Flash API van dit handboek.
Voltooiingscriteria
Voor het lezen van feiten is een daadwerkelijk bruikbaar ontvangstbewijs van een query of volledige brontekst nodig; bij het genereren van kandidaten moet worden vermeld dat ze nog niet zijn toegepast; publicatie vereist een echt APPLIED-ontvangstbewijs; bij annulering moet onderscheid worden gemaakt tussen verzoek en bevestiging. Antwoordtekst, HTTP 200, de melding dat een tool het verzoek heeft aangenomen of een modelomschrijving “voltooid” bewijzen op zichzelf niet dat een bedrijfsbewerking is geslaagd.
De bijbehorende reference/mcp-tool-catalog.json is een offline referentie van de declaraties in r56; het bevat ook voorwaardelijk ingeschakelde definities en is niet de realtime tools/list van welke gebruiker dan ook. De volledige catalogus omvat 28 kerntools voor de ontologie, 4 voorwaardelijke controlleruitbreidingen en 8 tools voor de Business Workspace; dat betekent niet dat ze standaard allemaal beschikbaar zijn.
Snel verbinden en mogelijkheden ontdekken
Begin met het officiële domein van de instantie en ontdek met minimale rechten welke tools daadwerkelijk beschikbaar zijn.
- Vraag de beheerder om het officiële HTTPS-basisadres en de ontologie of het bedrijfssysteem waartoe toegang nodig is. Gebruik de voorbeelddomeinen uit de documentatie niet voor aanroepen naar echte bedrijfsfuncties.
- Configureer het MCP-serveradres als https://flash.example.com/mcp; de Business Workspace gebruikt /mcp/business op hetzelfde domein.
- Start de OAuth-login en -autorisatie op de manier die de client ondersteunt en controleer resources en scope; stuur nooit gebruikersnaam en wachtwoord naar MCP.
- Gebruik de discovery of initialisatie van de betreffende protocolgeneratie en lees vervolgens tools/list en de resourcebeschrijvingen.
- Voer eerst een beperkt alleen-lezenverzoek uit, controleer de gestructureerde resultaten en fouten, en werk pas daarna aan het doel van de gebruiker.
Configuratiefragment voor de client
{
"mcpServers": {
"ot-flash": {
"url": "https://flash.example.com/mcp"
}
}
}Dit fragment toont de configuratie-intentie van het serveradres; de specifieke structuur van het configuratiebestand en OAuth-ondersteuning zijn afhankelijk van de client. Zet geen echte access_token, refresh_token, cookies of beheerderswachtwoorden in openbare bestanden.
Moderne protocoldiscovery
POST /mcp HTTP/1.1
Host: flash.example.com
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json
Accept: application/json, text/event-stream
MCP-Protocol-Version: 2026-07-28
Mcp-Method: server/discover
{
"jsonrpc": "2.0",
"id": 1,
"method": "server/discover",
"params": {
"_meta": {
"io.modelcontextprotocol/protocolVersion": "2026-07-28",
"io.modelcontextprotocol/clientInfo": {"name": "flash-client", "version": "1.0.0"},
"io.modelcontextprotocol/clientCapabilities": {}
}
}
}Controles vóór integratie
- Het basisadres van de resource, de OAuth-issuer en het externe adres van de reverse proxy komen overeen.
- De client ondersteunt de betreffende protocolgeneratie en stuurt niet standaard initialize naar het toegangspunt van het nieuwe protocol.
- De huidige autorisatie is gekoppeld aan de benodigde ontologie of het benodigde bedrijfssysteem.
- Het token is geldig en nieuwe optionele scopes zijn uitdrukkelijk geautoriseerd.
OAuth discovery, registratie en autorisatie
Gebruik een autorisatiecode met PKCE en stel de inloggegevens van het product niet bloot aan de Agent.
| Endpoint | Methode | Functie |
|---|---|---|
| /.well-known/oauth-protected-resource | GET | Resourcediscovery voor de ontologie-MCP |
| /.well-known/oauth-protected-resource/mcp | GET | Discovery via het compatibele ontologieresourcepad |
| /.well-known/oauth-protected-resource/mcp/business | GET | Resourcediscovery voor de Business Workspace-MCP |
| /.well-known/oauth-authorization-server | GET | Metadata van de autorisatieserver |
| /oauth/register | POST JSON | Dynamische registratie van een public client |
| /oauth/authorize | GET of POST form | Inloggen, resource selecteren en autorisatie bevestigen |
| /oauth/token | POST form | Autorisatiecode inwisselen en vernieuwen met rotatie |
| /oauth/revoke | POST form | Token-intrekking |
| /oauth/grants | GET | Ingelogde gebruiker bekijkt geautoriseerde verbindingen |
| /oauth/grants/revoke | POST form | Verbinding intrekken volgens het oorspronkelijke paginaproces |
Autorisatievolgorde
- Lees de metadata van de beveiligde resource en van de autorisatieserver. De 401 en de WWW-Authenticate-header die een verzoek zonder token terugkrijgt, verwijzen naar het adres voor resourcediscovery.
- Registreer of gebruik een clientidentiteit. Een public client die in r56 dynamisch wordt geregistreerd, gebruikt token_endpoint_auth_method=none; een clientgeheim is geen vervanging voor PKCE.
- Genereer een willekeurige state en code_verifier en bereken de S256 code_challenge.
- Open het authorize-adres uit de metadata en geef response_type=code, client_id, exacte redirect_uri, scope, resource, state, code_challenge en code_challenge_method=S256 mee.
- De gebruiker logt in bij DataFocus en selecteert een ontologie of bedrijfssysteem. De client mag geen resources vooraf selecteren waarop de gebruiker geen toegangsrecht heeft.
- Ontvang de callback, verifieer state en issuer; wissel de autorisatiecode in met de oorspronkelijke code_verifier.
- Gebruik het access_token uitsluitend voor MCP Bearer-authenticatie. Vernieuw via het oorspronkelijke OAuth-proces; sla het geroteerde refresh_token veilig op.
Registratievoorbeeld
{
"client_name": "OT Flash Knowledge Client",
"redirect_uris": ["http://127.0.0.1:8765/callback"],
"application_type": "native",
"token_endpoint_auth_method": "none",
"grant_types": ["authorization_code", "refresh_token"],
"response_types": ["code"]
}De callback van een webclient gebruikt HTTPS; native clients kunnen een ondersteund loopback-adres gebruiken. Autorisatie en token-uitwisseling moeten exact overeenkomen met de geregistreerde callback. Eén Grant is gericht op één protected resource; ontologie-scope en Business Workspace-scope worden niet gemengd in dezelfde verbinding.
Tokenlevensduur
Standaard is op de r56-server een access token 3600 seconden geldig, een refresh token 2592000 seconden en een autorisatiecode 300 seconden; een implementatie kan deze waarden overschrijven. De client baseert zich op expires_in uit het tokenantwoord en op de werkelijke fouten, en mag de standaardwaarden niet hardcoderen. Werk het token bij na vernieuwing; het intrekken van rollen, resourcerechten of een Grant zorgt ervoor dat volgende aanroepen worden geweigerd.
Scope, resourcegrenzen en realtime rechten
Het autorisatiebereik delegeert bestaande rechten, verleent geen rolverhoging en deelt geen bedrijfsstatus over Grants heen.
| Scope | Typische mogelijkheden | Belangrijke beperkingen |
|---|---|---|
| ontology.metadata:read | Ontologie, resources, tabelstructuur | Ontologie en tabellen moeten binnen het geautoriseerde en huidige leesbare bereik vallen |
| ontology.graph:read | Zoeken in de graaf en buurknooppunten | Retourneert lokalisatie-informatie, geen feitelijk bewijs |
| ontology.knowledge:read | Kennislokalisatie en volledige brontekst | Behoudt de oorspronkelijke rechten van kennisbank en document |
| ontology.table:query | SQL op ontologietabellen en query's op gepubliceerde modellen | Tabelquery's vereisen bovendien de metadata-scope; werkelijke bron- en kolomrechten blijven gelden |
| search:operate | Native trefwoordmodellen en sessies | Afzonderlijke, uitdrukkelijke delegatie; uitgevoerd met de oorspronkelijke modelrechten en de tabel- en kolomrechten van de gebruiker |
| etl:operate | Flash ETL capabilities | Geen toegang tot Heavy ETL |
| authoring.contract:read | Voorwaardelijk beschikbare modelleercontracten | Vereisen bovendien functieschakelaars en de betreffende resources |
| authoring.artifact:read | Kandidaten, plannen e.d. lezen binnen de huidige autorisatie | Gebonden aan de Grant van de oorspronkelijke principal en aan de resources |
| authoring.artifact:draft | Kandidaten indienen, voorbeeldweergave e.d. | Autoriseert geen uitvoering of publicatie |
| authoring.artifact:apply | Gecontroleerde plannen en toepassing | Vereisen nog steeds de oorspronkelijke bedrijfsrollen, beleid en goedkeuring |
| execution.script:draft | Specifieke scriptconcepten | Autoriseert geen daadwerkelijke scriptuitvoering |
| datasource.http:read / draft / test / import | Voorwaardelijk beschikbare artefactfuncties voor HTTP-databronnen | Elk onderdeel heeft een eigen schakelaar; de oorspronkelijke rechten blijven gelden |
Vereiste scopecombinaties voor lezen
dfc_table detail vereist ontology.metadata:read; query vereist bovendien ontology.table:query. dfc_ontology_query vereist de twee leesscopes graph en knowledge. dfc_knowledge_search/detail vereist knowledge. published_model/published_query gaat via table:query; candidate_query vereist bovendien authoring.artifact:read. Analysetools controleren bovendien de toegestane bewijsscopes; persistente rapporten vereisen metadata en table query.
Standaardautorisatie niet hardcoderen
De standaard ontologie-scopeverzameling van r56 bevat table query; Search en ETL zijn uitdrukkelijke delegaties. Uiteindelijk zijn de discovery-metadata, de autorisatiepagina, de werkelijke token-scope en tools/list doorslaggevend. Uitspraken in oudere documentatie zoals “de ontologie heeft standaard nooit SQL” of “slechts zes tools” kunnen niet als uitgangspunt voor de huidige implementatie dienen.
Statusisolatie
Sessies, rapporten, kandidaten en actieplannen hebben elk hun eigen eigenaar en bereik. Het vernieuwen van het access token draagt het werk van de oorspronkelijke Grant niet over aan een andere Grant. Neem geen sessionId, reportId, planId, goedkeuringstokens of brontokens die een andere verbinding heeft geretourneerd over in de huidige verbinding.
HTTP- en moderne MCP-berichten
Stuur per verzoek de juiste metadata en bijpassende routingheaders en behandel HTTP en toolresultaten afzonderlijk.
| Onderdeel | r56-gedrag |
|---|---|
| Transport | Stateless Streamable HTTP, POST JSON-RPC |
| Ondersteunde protocolversies | 2026-07-28 en ook 2025-11-25, 2025-06-18 en 2025-03-26 |
| Moderne methodes | server/discover tools/list tools/call resources/list resources/read, aangeboden volgens de werkelijke mogelijkheden |
| Sessieheader | Er wordt geen Mcp-Session-Id toegekend |
| GET en DELETE | /mcp en /mcp/business geven 405 terug |
| SSE-meldingen van de server | Niet beschikbaar op deze twee openbare MCP-toegangspunten |
| Cachen van de catalogus | Moderne discover- en list-aanroepen geven ttlMs=60000 en cacheScope=private terug |
| Normaal resultaat | Moderne resultaten bevatten resultType=complete en metadata met de identiteit van de service |
Inhoud die overeen moet komen
- MCP-Protocol-Version moet overeenkomen met io.modelcontextprotocol/protocolVersion in params._meta.
- Mcp-Method moet overeenkomen met de method van JSON-RPC.
- De Mcp-Name van tools/call moet overeenkomen met params.name; bij resources/read moet de naamheader overeenkomen met de URI.
- Elk modern verzoek bevat het io.modelcontextprotocol/clientCapabilities-object; geef daarnaast de standaard clientInfo mee, zodat de client kan worden herkend.
Voorbeeld van een aanroep
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "dfc_ontologies",
"arguments": {"page": 1, "pageSize": 20},
"_meta": {
"io.modelcontextprotocol/protocolVersion": "2026-07-28",
"io.modelcontextprotocol/clientInfo": {"name": "flash-client", "version": "1.0.0"},
"io.modelcontextprotocol/clientCapabilities": {}
}
}
}De bijbehorende HTTP-headers zijn Mcp-Method: tools/call en Mcp-Name: dfc_ontologies. In alle voorbeelden is ACCESS_TOKEN een placeholder. Zet het Bearer-token niet in de URL, JSON-parameters of cachesleutels.
Resultaten lezen
Behandel eerst de HTTP-status en controleer vervolgens op een JSON-RPC-fout; is er een result, controleer dan isError. Een succesvol toolresultaat levert doorgaans structuredContent én text-inhoud met dezelfde bedrijfs-JSON. Lees bij voorkeur het gestructureerde kanaal en tel text en structuredContent niet dubbel op als twee onafhankelijke feiten. HTTP 200 kan een mislukte toolaanroep bevatten.
Openbare resources en UI
De ingebouwde instructieresources zijn niet afhankelijk van MCP Apps. Het toegangspunt van de Business Workspace krijgt hierdoor geen instructieresources van de ontologie. Clients die visualisatie ondersteunen, ontdekken de bijbehorende UI via de werkelijke mogelijkheden en de _meta van de tool, en raden niet naar resource-URI's die niet zijn teruggegeven.
Compatibiliteit met clients van het oude protocol
Houd in clients die nog de initialisatie-handshake gebruiken één consistente protocolgeneratie aan.
{
"jsonrpc": "2.0", "id": 1, "method": "initialize",
"params": {
"protocolVersion": "2025-11-25",
"capabilities": {},
"clientInfo": {"name": "flash-legacy-client", "version": "1.0.0"}
}
}- Stuur initialize en lees de door de server onderhandelde protocolversie en capabilities.
- Stuur volgens het protocol van de client de vereiste melding dat de initialisatie is voltooid; meldingen leveren geen normaal toolresultaat op.
- Lees met tools/list de momenteel geautoriseerde tools en verstuur daarna tools/call.
- Houd headers en berichten consistent binnen de protocolgeneratie van het huidige verzoek en gebruik geen oude initialize- of ping-procedure bij berichten volgens 2026-07-28.
Het oude protocol gebruikt nog steeds dezelfde Bearer/OAuth, rechten en toolcontracten. Dat betekent niet dat de server per se een langdurige SSE-verbinding in oude stijl of een Mcp-Session-Id aanbiedt; de openbare service van r56 blijft stateless.
Protocolfouten
| Situatie | Typisch resultaat | Oplossing |
|---|---|---|
| Moderne headers en berichten komen niet overeen | HTTP 400 JSON-RPC -32020 | Corrigeer headers, metadata en toolnamen |
| Niet-ondersteunde versie | -32022 met een lijst van ondersteunde versies | Kies een daadwerkelijk ondersteund protocol |
| Onbekende methode | JSON-RPC -32601; bij moderne verzoeken mogelijk HTTP 404 | Controleer de protocolgeneratie en de methode |
| Ontbrekende of ongeldige parameters | JSON-RPC parameterfout of tool-isError | Corrigeer volgens de werkelijke inputSchema |
De juiste tool en het juiste bewijskanaal kiezen
Routeer op basis van de nog onbeantwoorde bedrijfsvraag en verzamel niet steeds opnieuw bewijs via een vaste aanroepketen.
| Taak | Voorkeurstool | Benodigd bewijs voor afronding |
|---|---|---|
| Geautoriseerde onderwerpen en resources ontdekken | dfc_ontologies dfc_ontology_resources | Werkelijke typen resource-id's en het momenteel zichtbare bereik |
| Tabelstatistieken en TopN | dfc_table query | Ontvangstbewijs van een geslaagde uitvoering en volledige evidenceRows |
| Beleid, contracten of rapporten opzoeken | dfc_ontology_query of knowledge search/detail | Volledige, geautoriseerde brontekst die als feit kan dienen |
| Graafobjecten lokaliseren | dfc_ontology_graph search/neighbors | Lokaliseer eerst de werkelijke bron en verkrijg daarna de bijbehorende feiten |
| Oorspronkelijke trefwoordinteractie | dfc_manual en daarna dfc_search | De werkelijke resultaten in het oorspronkelijke model en de bedrijfsframes |
| Geïntegreerde analyse en rapporten | dfc_analysis_* of dfc_report_* | De werkelijke status van elke gestructureerde vertakking en van het documentbewijs |
| Weergave of ontologiemodel wijzigen | dfc_authoring_* en artefacttools | Controleer kandidaten, plannen, goedkeuringen en toepassing afzonderlijk |
| Bedrijfsopdrachten uitvoeren | /mcp/business met dfb_* | Gepubliceerde contracten en het oorspronkelijke ActionPlan-ontvangstbewijs |
Onnodige aanroepen vermijden
Wanneer de actuele, volledige en geautoriseerde tabelstructuur al beschikbaar is, is het niet nodig om bij elke query opnieuw detail op te vragen; wanneer er al betrouwbare lokalisatie en bewijs voorhanden zijn, herhaal dan niet dezelfde zoekopdracht. Voer bij een ontbrekende dimensie een begrensde aanvullende query uit. Als een fout uitdrukkelijk niet opnieuw geprobeerd mag worden, dicht dan eerst het gat en vervang uw eigen afweging niet door “nog een keer proberen”.
Uitsluitingen van Flash
dfc_etl capabilities kan available=false en ETL_NOT_INCLUDED_IN_OT_FLASH teruggeven. De statische beschrijving van de ingebouwde ETL-functies dient als productoverstijgende referentie; ze bewijst niet dat ETL in Flash is geïnstalleerd en staat de Agent niet toe om voor de uitvoering automatisch over te schakelen naar Heavy of een andere tenant.
Ontologieresources en id-typen
Verkrijg eerst de werkelijke resourcecoördinaten om opslagnamen, document-id's en kennisbank-id's niet door elkaar te halen.
- Roep dfc_ontologies aan en blader met page en pageSize door de ontologieën die bij deze autorisatie zijn toegekend en momenteel nog leesbaar zijn.
- Roep dfc_ontology_resources aan met een werkelijke ontologyId; kies naar behoefte tables, answers, pinboards, documents en knowledgeBindings.
- Behandel paginering per resourcetype. pageSize is maximaal 100; leid de volledige omvang van de resource niet af uit de eerste pagina.
- Sla het door de resource gedeclareerde type en de oorspronkelijke id op en gebruik deze bij volgende aanroepen ongewijzigd.
{"name":"dfc_ontology_resources","arguments":{
"ontologyId":"<ONTOLOGY_ID>",
"resourceTypes":["tables","documents","knowledgeBindings"],
"page":1,"pageSize":100
}}| Coördinaten | Bron | Vervangt niet |
|---|---|---|
| ontologyId | Lijst van geautoriseerde ontologieën of de momenteel geldige context | Id van een andere ontologie |
| id van een tabelresource | tables-lijst of betrouwbare context | physicalName of weergegeven tabelnaam |
| tblDisplayName colDisplayName | Metadata van de huidige tabel en kolommen | Geraden fysieke SQL-identificatoren |
| knowledgeId | knowledgeBindings of een werkelijk ontvangstbewijs van een kenniszoekopdracht | id van een documentresource |
| assetId documentId chunkId evidenceId | Hetzelfde werkelijke ontvangstbewijs van de lokalisatie | Velden samengevoegd uit verschillende lokalisatieresultaten |
| rid revisionId releaseId | Gepubliceerd model of kandidaatcontext aan serverzijde | Zelfgegenereerde id of latest |
Afspraken over precisie
Geef bij alle 64-bits resource-id's de voorkeur aan decimale tekenreeksen en converteer ze niet via Number in JavaScript. Sommige bedrijfsschema's accepteren string of integer, maar dat betekent niet dat de precisie van gehele getallen mag worden opgegeven. Opaque locators, UUID, hashes en eenmalige tokens worden eveneens ongewijzigd bewaard.
Doris-tabelquery- en structuurcontract
Voer alleen-lezen SQL uit op geautoriseerde tabellen en behoud de semantiek van de uitvoer, exacte waarden en volledigheid.
Structuur lezen
{"name":"dfc_table","arguments":{
"action":"detail","ontologyId":"<ONTOLOGY_ID>","id":"<TABLE_RESOURCE_ID>"
}}Gebruik detail met een werkelijke tabelresource-id. Controleer schemaComplete, tblDisplayName, colDisplayName in columns en de gezaghebbende sqlDataType, evenals het geretourneerde queryContract. dataType is slechts een compatibiliteitsmapping; de fysieke opslagnaam is niet de tabelnaam die u in ingediende SQL gebruikt.
Query uitvoeren
{
"name": "dfc_table",
"arguments": {
"action": "query",
"ontologyId": "<ONTOLOGY_ID>",
"sql": "SELECT \"区域\", SUM(\"销售金额\") AS \"销售金额合计\" FROM \"电商销售数据\" WHERE \"订单状态\" = '已完成' GROUP BY \"区域\" ORDER BY \"销售金额合计\" DESC",
"maxRows": 100
}
}SQL-beperkingen
- Gebruik de weergavenamen van tabellen en kolommen en zet identificatoren tussen dubbele aanhalingstekens. Het verzoek is één alleen-lezen Doris-query binnen het bereik van de ontologie.
- Som de uitvoerkolommen expliciet op; SELECT * en table.* zijn verboden; zo kunnen de rechten op geregistreerde kolommen niet via fysieke kolommen worden omzeild.
- Gebruik bij joins expliciete JOIN ... ON; NATURAL JOIN en JOIN USING worden geweigerd.
- Geldige multidimensionale aggregaties, CTE's, vensterfuncties, CASE, COUNT(DISTINCT ...) en andere alleen-lezen expressies zijn toegestaan; dat de semantische validatie een expressie niet afdekt, betekent niet dat de uitvoering ervan altijd verboden is.
- Voltooi aggregatie, sortering en rangschikking eerst in SQL en pas daarna de resultaatlimiet toe. maxRows is standaard 100, maximaal 200.
Datum en tijdzone
| Type of doel | Vorm | Let op |
|---|---|---|
| DATE | CAST('2026-09-01' AS DATE) en CURRENT_DATE | Neem niet automatisch aan dat een tekstliteral een datumtype is |
| DATETIME | CAST('2026-09-01 00:00:00' AS DATETIME) en CURRENT_TIMESTAMP | Controleer de brontijdzone en de sessietijdzone |
| Relatieve tijd | DATE_SUB(CURRENT_DATE, INTERVAL 1 YEAR) | Gebruik voor datums en tijdstempels de overeenkomstige huidige functies |
| Tijdgroepering | YEAR(column) of DATE_TRUNC(column, 'month') | Gebruik voor elke uitvoer een unieke alias; queryContract is leidend |
De DATE('now', ...)-functie van SQLite is niet het Doris-datumcontract van dit toegangspunt. Neem de SQLite-offlineverificatiemethode uit documentatievoorbeelden niet over in de online SQL.
Het v8-queryontvangstbewijs lezen
evidenceRows is het enige kanaal waarmee de Agent rijgegevens benadert; raw data is niet toegankelijk voor de Agent. SQL-getallen worden gecodeerd als exacte decimale JSON-tekenreeksen; bepaal de numerieke waarde en het bedrijfstype aan de hand van resultColumnContracts en interpreteer een waarde in JSON niet als VARCHAR alleen omdat ze een tekenreeks is. Lees de informatie over executionReceipt, volledigheid en afkapping en bewaar broninformatie zoals evidenceRowsSha256.
Query-uitvoer met een citeerbaar ontvangstbewijs mag letterlijk worden geciteerd; alleen semantiek die door de server is geverifieerd, geeft toestemming voor daaropvolgende deterministische herberekeningen. Leid uit veldnamen niet zelf “cumulatief saldo”, “eindwaarde” of “valuta” af en vul geen eenheden zelf aan. Resultaten zonder rijen, fouten of afkapping mogen niet als volledige statistiek worden beschreven.
Multidimensionale Top3 en omgang met afkapping
Beantwoord rangvragen met aggregatie en vensterfuncties aan serverzijde; voer geen tweede berekening uit op onvolledige resultaten.
Het bijbehorende examples/top3.sql gebruikt de voorbeeldtabel: het aggregeert eerst op 区域, 类别 en 产品, voert daarna binnen elke combinatie van 区域 en 类别 een ROW_NUMBER uit en gebruikt de productnaam als stabiele volgorde bij gelijke bedragen. Een verzoek met maxRows=100 volstaat voor de 36 rijen van het voorbeeld; voor andere bedrijfsgegevens gaat u uit van het werkelijke aantal groepen.
- Haal de werkelijke structuur en de geldende definities op en leg valuta, periode, orderstatus (订单状态) en de regel voor gelijke waarden vast.
- Dien SQL in die de aggregatie en rangschikking aan serverzijde uitvoert. Vraag niet eerst alleen de totalen per 区域 op om die vervolgens als productranglijst per 类别 te gebruiken.
- Controleer het uitvoerkolomcontract en de werkelijke evidenceRows en bevestig dat de geretourneerde resultaten alle benodigde groepen dekken.
- Bij afkapping voert u begrensde partitiequery's uit binnen de door de server ondersteunde grenzen, bijvoorbeeld per 区域 telkens de volledige Top3 ophalen; hanteer telkens dezelfde bedrijfsdefinitie.
- Als de bronperiode verandert, voert u de query opnieuw uit en vermeldt u expliciet de nieuwe versie; meng geen verschillende dataversies of verlopen cursors.
Foutherstel
TABLE_SCHEMA_INCOMPLETE moet worden gecorrigeerd of de volledige structuur moet worden opgevraagd; fouten zoals ONTOLOGY_SQL_FAILURE_CONTRACT_INVALID worden afgehandeld volgens de geretourneerde errorCode, retryable en remediation. Beweer niet dat “alle multidimensionale GROUP BY-clausules of vensterfuncties verboden zijn” en verzin geen ranglijsten als er geen queryresultaten zijn.
Kennis zoeken, volledige brontekst en bewijsgeschiktheid
Houd lokaliseren, lezen en het citeren van feiten gescheiden en behoud herkomst en volledigheid.
Twee gebruikelijke paden
| Pad | Doel | Kernpunten |
|---|---|---|
| dfc_ontology_query | Zoeken binnen de aan de ontologie gebonden kennis, eventueel gecombineerd met graafroutering | Controleer de volledige canonical answerContextItems en de bewijsgeschiktheid |
| dfc_knowledge_search → dfc_knowledge_detail chunk | Expliciet zoeken om te lokaliseren, daarna het geselecteerde fragment lezen | De voorbeeldweergave van een zoekresultaat geldt niet als feit; lees de volledige brontekst van dezelfde lokalisatie |
{"name":"dfc_knowledge_search","arguments":{
"ontologyId":"<ONTOLOGY_ID>","query":"销售金额是否排除退货", "topK":5
}}
{"name":"dfc_knowledge_detail","arguments":{
"action":"chunk","ontologyId":"<ONTOLOGY_ID>",
"evidenceId":"<EVIDENCE_ID_FROM_THE_SAME_SEARCH_RESULT>"
}}Voorwaarden voor feitelijk gebruik
- Controleer de huidige ACL, de volledigheid van de inhoud en de canonicalFactEligible, citationEligible of het overeenkomstige uitvoeringscontract aan serverzijde.
- Volledige inhoud is gebonden aan contentSha256. Afgekapte inhoud, inhoud die vanwege het budget is weggelaten en inhoud van lage kwaliteit behandelt u volgens de werkelijke velden.
- Documentmetadata, page_context, graaflokalisatie, zoeksamenvattingen en voorbeeldweergaven vervangen de canonical brontekst niet.
- Kopieer bij voorkeur de evidenceId; wanneer u chunkId en documentId nodig hebt, moeten beide uit hetzelfde lokalisatieresultaat komen; stel ze niet samen uit verschillende resultaten en verzin ze niet.
Graafroutering
Het search/neighbors-resultaat is lokalisatie-informatie. Geef uitsluitend het volledige, door de server geretourneerde routeLocator-object door aan de ontologiequery, inclusief binding-, versie- en bewijsvelden. Verpak een assetId of knowledgeId niet zelf als door de server uitgegeven locator en stuur geen door het model beweerde herkomstbewijzen terug.
Gestructureerd documentherstel
De structuredPlan van dfc_ontology_query is bedoeld voor beperkt herstel en deterministische verificatie van onregelmatige documenttabellen. Gebruik het door de server gedeclareerde plan pas nadat de huidige executionContractSha256, tableIndex, de kolommen en de volledige tabel zijn geretourneerd. Gewone reeds geïmporteerde bedrijfstabellen verlopen via dfc_table SQL; behandel het herstel van Markdown-tabellen niet als een route om autorisatie voor tabelquery's te omzeilen.
Zoekstrategie
knowledgeIds wordt meestal weggelaten, zodat alle momenteel actieve bindingen worden gedekt; geeft u het wel op, gebruik dan uitsluitend echte kennisbank-id's uit knowledgeBindings. Gebruik een documentresource-id niet als kennisbank-id. Voer voor een nog onopgeloste vraag een nieuwe, begrensde zoekopdracht uit en vermijd exact herhaalde zoekopdrachten die geen nieuw bewijs opleveren.
Native Search-model en -sessies
Gebruik via dfc_search het trefwoordprotocol van Rust Search en wacht op de eindtoestand van het oorspronkelijke bedrijfsframe.
Lees eerst de instructies voordat u mogelijkheden ontdekt
{"name":"dfc_manual","arguments":{
"action":"read","uri":"datafocus://manuals/search-keyword-queries/v1"
}}
{"name":"dfc_search","arguments":{"action":"capabilities"}}dfc_search vereist uitdrukkelijk de scope search:operate. De tool omhult de oorspronkelijke trefwoord-WebSocket en herschrijft trefwoorden niet tot SQL- of LLM-verzoeken. De sessie is gebonden aan de huidige tenant, gebruiker, Grant, client en het model; bij elke bewerking worden de oorspronkelijke tabel- en kolomrechten opnieuw gecontroleerd.
Minimale sessiestroom
{"name":"dfc_search","arguments":{
"action":"model_create","data":{"tableIds":["<ACTUAL_TABLE_ID>"]}
}}
{"name":"dfc_search","arguments":{
"action":"open","data":{"sourceToken":"<MODEL_SOURCE_TOKEN>","language":"en-US"}
}}
{"name":"dfc_search","arguments":{
"action":"poll","data":{"sessionId":"<SEARCH_SESSION_ID>","waitMillis":10000}
}}
{"name":"dfc_search","arguments":{
"action":"request","data":{"sessionId":"<SEARCH_SESSION_ID>",
"message":{"type":"assist","datas":{}}}
}}
{"name":"dfc_search","arguments":{
"action":"request","data":{"sessionId":"<SEARCH_SESSION_ID>",
"message":{"type":"search","datas":{"search":"<QUERY_USING_ACTUAL_COLUMNS>","ambiguities":[]}}}
}}- Gebruik model_create met 1 tot 100 echte tabel-id's waarop u rechten hebt, of model_read om een bestaand sourceToken van uzelf te lezen.
- open geeft alleen initializationSent terug; voer eerst poll uit, lees het oorspronkelijke init-bedrijfsantwoord en controleer of de initialisatie is geslaagd.
- Lees assist en de suggesties en verstuur daarna een ondersteund oorspronkelijk message. In de datas van query zet de wrapper isNl vast op false.
- Lees doorlopend frames en maak onderscheid tussen suggesties, parsing, ontvangst en het uiteindelijke bedrijfsresultaat.
- Sluit af met close; gebruik cancel om te annuleren en controleer aan de hand van de werkelijke taakstatus of de taak is beëindigd.
| action | data | Betekenis |
|---|---|---|
| capabilities | Weglaten of leeg object | Acties, commando's, TTL en transportinstructies lezen |
| model_create | tableIds-array | Een geautoriseerd model voor de huidige gebruiker maken |
| model_read | sourceToken | Model lezen; kolommen zonder rechten en gevoelige bronconfiguraties worden gefilterd |
| open | sourceToken met optionele language | Een native sessie opzetten en init versturen |
| request | sessionId en message | Oorspronkelijk type/datas-protocolbericht versturen |
| poll | sessionId met waitMillis van 0 tot 30000 | De huidige gebufferde frames ophalen, eventueel met een begrensde wachttijd |
| cancel close | sessionId | Deze native sessie sluiten; hieruit volgt geen BI-eindtoestand |
Ondersteunde oorspronkelijke commando's
search associateSearch guide assist exportContext reInit
putFormula modifyFormula deleteFormula fnamecheck
disambiguite reDisambiguite clearDisambiguiteHoofdlettergebruik van commando's en de datas-structuur volgen de huidige capabilities en het oorspronkelijke sessieprotocol. Voeg geen niet-bestaande acties toe aan request; zo moet bijvoorbeeld de spelling disambiguite behouden blijven zoals het werkelijke protocol die gebruikt. Een bericht is maximaal 256 Ki tekens.
Sessie en volledigheid
De sessie-TTL bedraagt 10 minuten en de sessie blijft alleen bestaan zolang het huidige proces draait; het is geen taak die duurzaam kan worden hervat. De buffer bevat maximaal 256 frames en is gebonden aan een geheugenlimiet; als bufferOverflow=true, mag u opgehaalde frames niet als volledig resultaat beschouwen. Poll na een transportfout eerst de oorspronkelijke sessie en stuur een mogelijk al uitgevoerde query niet blindelings opnieuw.
De huidige wrapper biedt geen antwoord- of pinboard-opslag, geen lees-/schrijftoegang tot geschiedenis en geen herstel van willekeurige context. Het bestaan van exportContext betekent niet dat u willekeurige context zelf kunt herstellen. Gebruik voor het opslaan van resultaten de oorspronkelijke resourcefuncties die de instantie daadwerkelijk beschikbaar stelt, en verzin geen action.
Taal- en regioconventies
Houd UI-locale, querywoordenboek, antwoordtaal en oorspronkelijke veldnamen strikt gescheiden.
De prioriteit is: expliciet aangevraagde taal, taal van het applicatiesysteem, de locale van het daadwerkelijk uitvoerende knooppunt. Een weggelaten waarde, null, een lege tekenreeks of alleen witruimte leidt niet vast tot terugval op het Chinees. De regiowaarden in languageRegistry moeten exact blijven; vouw en-GB, fr-CA, pt-BR, es-US of ar-AE niet zomaar samen tot een andere regio.
| Taal of regio | Query-locale | Toelichting |
|---|---|---|
| Vereenvoudigd Chinees, Traditioneel Chinees | zh-CN zh-Hant | De oorspronkelijke Chinese regels verschillen van de catalogus voor traditioneel Chinees |
| Amerikaans, Brits, Australisch en Canadees Engels | en-US en-GB en-AU en-CA | UI- en trefwoordpakket kunnen worden gedeeld; regiometadata blijven behouden |
| Duits, Italiaans, Russisch | de-DE it-IT ru-RU | Gebruiken volgens de suggesties van de huidige sessie |
| Spaans en Latijns-Amerikaans Spaans | es-ES es-US | De regio-id van het product is es-US |
| Frans en Canadees Frans | fr-FR fr-CA | Regio-id's worden niet samengevoegd |
| Portugees en Braziliaans Portugees | pt-PT pt-BR | Catalogus- en regioconventies worden apart bewaard |
| Nederlands, Deens, Noors, Fins en Zweeds | nl-NL da-DK nb-NO fi-FI sv-SE | Noors is Bokmål |
| Japans, Koreaans | ja-JP ko-KR | Pas geen eigen woordsplitsing met Engelse spatiëringsregels toe |
| Saoedi-Arabisch en Emiraats Arabisch | ar-SA ar-AE | Interfacebeschrijvingen ondersteunen RTL; protocolidentificatoren worden niet gespiegeld |
De trefwoordcatalogus gebruiken
{"name":"dfc_manual","arguments":{
"action":"keywords","locale":"de-DE","names":["<ACTUAL_KEYWORD_ID>"]
}}De statische trefwoordcatalogus van dfc_manual bevat alleen expliciet vermelde locales; bij weglating geldt de Engelse referentie. Dat is de standaardreferentie, geen regel voor het bepalen van de querytaal. Wanneer voor een regiovariant geen statische catalogus beschikbaar is, haalt u de werkelijke suggesties op via de assist van de huidige sessie; verzin geen aliassen of terugvalresultaten. names bevat per aanroep maximaal 32 items.
Wat niet wordt vertaald
- Tabellen, kolommen, enumwaarden, klantnamen, formulenamen en andere echte modeltekenreeksen.
- Toolnamen, action, scope, Schema-velden, foutcodes en statuswaarden.
- Resource-id's, hashes, opaque locators en door de server uitgegeven referenties.
Met een Duitstalige vraag kunt u bijvoorbeeld de kolom met de Chinese weergavenaam “销售金额” opvragen. Wie die naam in een Duitse kolomnaam verandert, krijgt een andere identificator en geen vertaling van de interface. Initialiseer de sessie na een taalwijziging opnieuw of werk deze bij conform het oorspronkelijke protocol en haal suggesties en disambiguatiekandidaten opnieuw op.
Geïntegreerde analyse en interactieve resultaten
Behoud in de voorwaardelijk beschikbare analysetools de status van autorisatie, versie, vertakking en bewijs.
dfc_analysis_* wordt aangestuurd door datafocus.mcp.analysis.tools.enabled. Het gestructureerde deel loopt verder via de autoritatieve Search-query's en het huidige rijbeleid; voor het documentdeel wordt opnieuw de volledige brontekst onder de huidige ACL opgehaald. Ze vormen geen toegangspunt voor open SQL of voor het injecteren van willekeurige instructies of filters.
| Tool | Doel | Noodzakelijke coördinaten |
|---|---|---|
| dfc_analysis_ask | Een analysevraag in natuurlijke taal stellen | ontologyId question, optioneel language sessionId |
| dfc_analysis_result_get | Eerder geretourneerd resultaat lezen | ontologyId sessionId resultId |
| dfc_analysis_refine | Doorvragen of wijzigen op basis van het meest recente volledige resultaat | Oorspronkelijk resultaat expectedRevision en stabiele idempotentiesleutel |
| dfc_analysis_page | Eén pagina van een vertakking aan serverzijde ophalen | Oorspronkelijke vertakking en resultaatversie pageNo pageSize |
| dfc_analysis_cancel | Een resultaat annuleren dat nog in behandeling is | Oorspronkelijke sessie en resultaat |
| dfc_analysis_close | Een sessie vrijgeven die niet meer actief is | Oorspronkelijke sessie |
Analyse starten
{"name":"dfc_analysis_ask","arguments":{
"ontologyId":"<ONTOLOGY_ID>",
"question":"按区域分析已完成订单销售金额,并引用退货统计口径",
"language":"zh-CN"
}}- Lees de geretourneerde sessionId, resultId, status en revision; lees zo nodig het oorspronkelijke resultaat verder uit.
- Controleer de status, volledigheid, het rijbeleid en de bronnen van elke gestructureerde vertakking afzonderlijk; de voltooiing van één vertakking staat niet gelijk aan de volledigheid van de gehele analyse.
- Controleer documentbewijs, het feitenregister, citatiegeschiktheid en beperkingen. Door het model gegenereerde tekst kan de bewijsgeschiktheid niet op eigen kracht verhogen.
- Baseer een vervolgvraag op het meest recente volledige resultaat en geef expectedRevision mee; gebruik bij een nieuwe poging voor dezelfde wijziging dezelfde idempotentiesleutel.
- Controleer vóór het sluiten dat de sessie niet meer actief is; annuleren en sluiten zijn verschillende acties.
Gecontroleerde filtering en paginering
filter_patch gebruikt de door de server gegeven branchId, fieldRef, valueRef en toegestane operatoren; huidige getypeerde filters ondersteunen alleen EQ. Het is verboden opaque verwijzingen te vervangen door ruwe SQL, tableId, columnId of een filterboom die de client zelf samenstelt. Bij paginering begint pageNo bij 1 (maximaal 10000); pageSize is maximaal 100.
Hints over mogelijkheden en gedrag
Tool-annotations zijn hints voor de client, geen beveiligingsautorisaties. Sommige algemene sjablonen gebruiken readOnlyHint, wat geen vervanging is voor de beoordeling van de daadwerkelijke actie; annuleren, sluiten en het maken van een rapport wijzigen de betreffende werkstatus. Handel altijd volgens de semantiek van de tool, het doel van de gebruiker en de rechten aan serverzijde.
Persistente visualisatierapporten en MCP Apps
Maak herstelbare rapporten en lees de resultaten en interactieve interface ervan volgens de huidige rechten.
dfc_report_* wordt aangestuurd door datafocus.mcp.analysis.report-tools.enabled en vereist metadata- en table query-scope. Het verschilt van een in-process Search-sessie; rapporten gebruiken een persistente reportId; persistentie betekent niet dat rechten niet meer worden gecontroleerd.
{"name":"dfc_report_create","arguments":{
"ontologyId":"<ONTOLOGY_ID>","goal":"比较区域与类别销售表现并核对口径",
"title":"零售经营分析","language":"zh-CN",
"idempotencyKey":"retail-report-20261019-01"
}}
{"name":"dfc_report_status","arguments":{
"ontologyId":"<ONTOLOGY_ID>","reportId":"<REPORT_ID>"
}}Workflow
- Gebruik bij het maken een stabiele idempotencyKey van 8 tot 128 ondersteunde tekens.
- Sla reportId op, poll de status en controleer de werkelijke status zoals voltooid, mislukt, gedeeltelijk voltooid of geannuleerd.
- Controleer bij het lezen van resultaten de gestructureerde vertakkingen, visualisaties, feitenbronnen, documentcitaten en volledigheid.
- Gebruik de oorspronkelijke reportId om een onvoltooid rapport te annuleren; maak geen ander rapport aan als vervanging voor het annuleren.
- Lees na een netwerktime-out eerst de status van het oorspronkelijke rapport; een herhaling met de oorspronkelijke idempotentiesleutel moet dezelfde bedrijfsintentie behouden.
MCP Apps
Clients die UI-uitbreidingen ondersteunen, lezen rapportpagina's via de _meta van de tool en de werkelijke resourcediscovery. De persistente rapportpagina behorend bij r56 is ui://datafocus/analysis-report/v16/index.html; voor interactieve analyse worden de bijbehorende serverresourceverwijzingen gebruikt; clients mogen de door de tool geretourneerde waarden niet vervangen door hardgecodeerde waarden. Zonder UI-uitbreiding kunnen gestructureerde resultaten nog steeds worden gelezen.
Origin-binding
Bij het lezen van rapporten worden Grant, ontologie, de binding aan de Origin van het verzoek en de huidige tabelrechten opnieuw gecontroleerd. Voor cross-origin-integratie in de browser moet de goedgekeurde werkelijke origin worden gebruikt; clients omzeilen de binding niet via een vervalste Origin. Een oude reportId is geen permanente openbare link en ook geen toegangsbewijs voor andere gebruikers.
Artefactconcepten, voorbeeldweergave, plan en toepassing
Dien gegenereerde inhoud in bij de oorspronkelijke server voor normalisatie, validatie en goedkeuring; laat het model niet rechtstreeks productieresources wijzigen.
Artefacttools vereisen een ingeschakelde authoring-functie, een werkelijk artefacttype, de betreffende scope en de oorspronkelijke schrijfrechten van beheerders. Standaard zijn de typen geconfigureerd als CONTROL_PANEL_SPEC en VIEW_SPEC; andere typen voor formulieren, HTTP-bronnen of scripts vallen daarnaast onder een afzonderlijke configuratie. Flash heeft geen AutoML, dus de betreffende typen worden niet als beschikbare artefacten in deze versie vermeld.
- dfc_authoring_capabilities leest de contracten en acties die beschikbaar zijn onder de huidige Grant.
- dfc_artifact_context haalt begrensde context, contractVersion, contextHash, baseArtifactHash en baseArtifactVersion op.
- Genereer kandidaten aan clientzijde op basis van de werkelijke contracten; voer code daarin niet uit.
- dfc_artifact_submit dient de oorspronkelijke context en kandidaat in, houdt de instruction identiek en gebruikt een stabiele clientRequestId.
- Lees proposalId, candidateHash, de validatieresultaten en de voorbeeldweergave; reviseer de kandidaat bij werkelijke fouten en vervals geen geslaagde serverstatus.
- Is een nieuwe voorbeeldweergave nodig, gebruik dan dfc_artifact_preview en dezelfde kandidaathash.
- dfc_artifact_plan maakt een onveranderlijk plan met de echte kandidaat, doelversie en idempotentiesleutel.
- Verwerk goedkeuringen volgens de oorspronkelijke interactieve goedkeuring of een reeds geautoriseerd beleid, en voer daarna dfc_artifact_apply uit; alleen een APPLIED-ontvangstbewijs betekent dat de wijziging werkelijk is toegepast.
Minimaal contextverzoek
{"name":"dfc_artifact_context","arguments":{
"artifactType":"CONTROL_PANEL_SPEC",
"ontologyId":"<ONTOLOGY_ID>",
"instruction":"为当前授权销售指标建立区域比较面板"
}}VIEW_SPEC gebruikt de huidige geautoriseerde projectId; gebruik bij het bewerken van een bestaand artefact de werkelijke artifactId. Geef velden zoals variables, previewInput en viewport op volgens het geretourneerde contract en verzin geen interne kandidaatstructuur.
Gelijktijdigheid en nieuwe pogingen
Het plan is gebonden aan doelversie, kandidaathash en idempotentiesleutel. Na een wijziging van het doel kan het oude plan niet meer worden toegepast; lees de context opnieuw en behandel de werkelijke conflicten. Een transporttime-out bewijst geen mislukking; vraag eerst met dfc_artifact_status de oorspronkelijke proposalId of planId op. READY is niet APPLIED.
Goedkeuring en automatisch beleid
Algemene artefactplannen vereisen de oorspronkelijke menselijke goedkeuring. Plannen die voldoen aan het automatische publicatiebeleid van de ontologie worden volgens approvalMode verwerkt, zonder dat de gebruiker nog een door de Agent verzonnen goedkeuring hoeft te ondertekenen. approvalToken is door de server uitgegeven materiaal en kan niet door de Agent worden vervangen door een zelfgeschreven tekenreeks; de werkelijke inputSchema en het ontvangstbewijs van het plan bepalen de verplichte velden.
Ontologiekandidaten maken en publicatiecontract
Gebruik de afzonderlijk geversioneerde ontologiedeclaraties en publicatieconfiguratie; pas het contract voor gewone weergave-artefacten niet toe op modelpublicatie.
Kandidaat maken
De ontologiecontainer moet al bestaan en binnen de Grant vallen. Gebruik dfc_ontology_table_schema om de huidige gestructureerde bronvelden en de v4 Binding-vingerafdruk te controleren; u kunt per veld volstaan met alleen sourceField, waarna het type automatisch wordt bepaald. Een expliciete DECIMAL-declaratie vereist de huidige precisie en het aantal decimalen; andere typen bevatten deze twee velden niet.
{"name":"dfc_ontology_table_schema","arguments":{
"ontologyId":"<ONTOLOGY_ID>","sourceAssetRef":"table:<ACTUAL_TABLE_ID>",
"fields":[{"sourceField":"区域"},{"sourceField":"销售金额"}]
}}Kandidaat- en publicatieconfiguratie
| Contract | Doel | Belangrijke grenzen |
|---|---|---|
| ontology-workspace-create-mcp-submit-v1 | Kandidaat maken met lokale declaraties | Werkelijk geautoriseerde bronnen, compilatie aan serverzijde; voltooiingsbewijzen worden niet geaccepteerd |
| ontology-workspace-create-mcp-submit-v2 | Lokale declaraties combineren met exacte verwijzingen naar gepubliceerde versies | Geef de exacte releaseSelections en de afhankelijkheden van de referentieafsluiting op |
| ontology-publication-mcp-submit-v1 tot en met v3 | Een bestaande kandidaat binden aan een verzoek om een publicatieplan | Expliciete coördinaten; doel, bron, goedkeuring en validatie leidt de server zelf af |
| ontology-publication-mcp-submit-v4 tot en met v6 | Afzonderlijk ingeschakelde configuratie met betrekking tot automatische publicatie | Alleen gebruiken als capabilities en het werkelijke schema dit declareren |
| ontology-initial-activation-retirement-submit-v1 | Gecontroleerde initiële activering en buitendienststelling | Afzonderlijk plan, nieuwe menselijke goedkeuring en exacte scope |
Publicatievolgorde
- Haal van de huidige kandidaat de workspaceId, workspaceRevision, candidateHash en de werkelijke bronnen op.
- Kies de contractversie op basis van de servermogelijkheden; dien coördinaten zoals releases en selection in, zonder velden die zichzelf “goedgekeurd” of “geslaagd” noemen.
- Bewaar de door submit geretourneerde proposalId en de oorspronkelijke idempotencyKey. submit en MODEL_PLAN zijn verschillende fasen van dezelfde aanvraag.
- Roep dfc_artifact_plan aan met de oorspronkelijke kandidaat, doelversie en dezelfde idempotentiesleutel.
- PLANNING_INCOMPLETE betekent alleen dat er nog geen geldig plan is gevormd; VALIDATION_UNSATISFIED betekent dat er nog lacunes in de huidige validatie zijn; handel volgens nextAction.
- Ga na een geslaagd plan verder op basis van HUMAN_REQUIRED of POLICY_AUTO; gebruik daarbij de oorspronkelijke goedkeurings- en publicatiefuncties.
- Bevestig het resultaat met het APPLIED-ontvangstbewijs en daarna door het gepubliceerde model werkelijk te lezen en er een geautoriseerde query op uit te voeren.
Time-outs en herstel
Lees na een PLAN-time-out de oorspronkelijke proposalId. MODEL_PLAN_SUBMITTED is een onvoltooide aanvraag; MODEL_PLAN_COMPLETED betekent dat het oorspronkelijke ontvangstbewijs moet worden opgehaald met de oorspronkelijke coördinaten en sleutel, niet dat de client een nieuwe aanvraag moet maken. Terminale validatielacunes kunnen niet worden omgezet in een geslaagde publicatie door van sleutel te wisselen of opnieuw in te dienen.
Menselijke bedrijfsrechten
De door de Agent verstrekte instruction en declaraties zijn Agent-invoer, geen ondertekening van menselijk beleid. MODEL_AUTHOR, MODEL_PUBLISH, delegatie van automatische publicatie, bedrijfsbevestiging, vertrouwen in publieke sleutels, budget en bron-ACL blijven door de oorspronkelijke mechanismen bepaald. Deze feiten mogen niet worden vervangen door clientvelden.
Gepubliceerde modellen, kandidaatquery's en referentieafsluiting
Gebruik gepubliceerde bedrijfskennis in een exacte versie en behandel niet-gepubliceerde kandidaten als tijdelijk.
published_model, published_query en candidate_query van dfc_ontology_graph zijn voorwaardelijk beschikbare, gestructureerde configuraties en geen synoniemen van een gewone search/neighbors. Ze worden geautoriseerd volgens table query en de benodigde leesrechten voor modellering; zichtbaarheid in de graaf vervangt geen tabelrechten.
Gepubliceerd model lezen
- Wanneer de action-enum van de tool daadwerkelijk published_model bevat, dient u een echte committed releaseId in.
- v1 retourneert geautoriseerde querysjablonen; v2 voegt exacte PERSISTED-verwijzingen en releaseSelections toe; v3 voegt afhankelijkheidsverwijzingen, exacte domainRef en compacte bindingssjablonen toe.
- Kies objecten, attributen, Binding, scope en versie uit de werkelijke retourwaarden; genereer geen RID's en gebruik geen latest.
- Dien vaste getypeerde query's in voor published_query; resultaten moeten nog steeds door de huidige bron- en veldautorisatie gaan.
Kandidaatquery
candidate_query gebruikt de werkelijke workspaceId, revision, candidateHash en kandidaatdeclaraties. Combineert u dit met gepubliceerde verwijzingen, gebruik dan de bijbehorende getypeerde v2-LOCAL/PERSISTED-coördinaten en exacte selecties. Kandidaatresultaten zijn altijd ongepubliceerd en tijdelijk en mogen niet worden beschouwd als door de onderneming bevestigde kennis.
Gedeeltelijk onderhoud en afsluiting
Selecteer alleen de transitieve afhankelijkheden die nodig zijn voor de kandidaatwortel en zorg ervoor dat elke gepubliceerde verwijzing een exacte releaseSelections heeft. Het kopiëren van de publicatietekst, het indienen van slechts een reeks id's of het uitbreiden naar alle historische resources kunnen de huidige afhankelijkheids- en broncontroles niet vervangen.
De query van deze acties is een geversioneerd getypeerd object; SQL, fysieke tabel-id's of brontabelnamen worden niet geaccepteerd als vervanging van de bedrijfsverwijzingen. Metadatasjablonen en graafresultaten zijn op zichzelf niet citeerbaar als feit.
Ontologie-agenttaken delegeren
Hervat werk met persistente taken en de oorspronkelijke Grant; behandel Agent-instructies niet als menselijke goedkeuring.
dfc_ontology_agent wordt alleen weergegeven wanneer de werkelijke Pi Runtime en de bijbehorende rechten beschikbaar zijn. QUERY gebruikt leesmogelijkheden; AUTHORING vereist bovendien een modelleerrol en de bijbehorende authoring-scope. De tool stelt geen aparte, onbeperkte uitvoeringsengine beschikbaar.
{"name":"dfc_ontology_agent","arguments":{
"contractVersion":"ontology-agent-task-v1","action":"start",
"ontologyId":"<ONTOLOGY_ID>","mode":"QUERY",
"instruction":"列出当前可查询的表,并说明各表用途",
"idempotencyKey":"retail-discovery-01"
}}
{"name":"dfc_ontology_agent","arguments":{
"contractVersion":"ontology-agent-task-v1","action":"status",
"ontologyId":"<ONTOLOGY_ID>","runId":"<RUN_ID>"
}}Strikte parametersets
start gebruikt contractVersion, action, ontologyId, mode, instruction, idempotencyKey; status/cancel gebruikt contractVersion, action, ontologyId, runId. De server controleert de exacte veldenset per action. instruction is maximaal 16000 tekens; sleutels bestaan uit 1 tot 128 ondersteunde tekens en beginnen met een letter of cijfer.
Hervatten en annuleren
- Bewaar de oorspronkelijke runId, Grant, mode en idempotentiesleutel.
- Dezelfde sleutel met dezelfde instruction hervat dezelfde run en dient geen andere taak opnieuw in; dezelfde sleutel met een andere instruction wordt geweigerd.
- status vraagt de status van de oorspronkelijke taak op. Ook na voltooiing moeten de tabelquery's, het bewijs of de ontvangstbewijzen van publicatie worden gecontroleerd.
- Annuleren gebruikt de oorspronkelijke runId; bevestig het resultaat met de werkelijke taakstatus.
Een voltooide run is geen ontvangstbewijs van modelpublicatie. Publicatietaken worden nog steeds bevestigd via de oorspronkelijke artefactstatus en broncontroles; QUERY omvat geen impliciete schrijf- of publicatierechten.
MCP voor de Business Workspace
Bevraag records op basis van gepubliceerde bedrijfscontracten en voer commando's uit via het oorspronkelijke ActionPlan.
/mcp/business gebruikt een eigen protected resource en een eigen selectie van bedrijfssystemen; een ontologie-Grant kan niet worden hergebruikt in plaats van een bedrijfsautorisatie. Een bedrijfssysteem moet gepubliceerd zijn, door Agents kunnen worden aangeroepen en voldoen aan het oorspronkelijke beveiligingsbeleid, en de huidige gebruiker moet een werkelijke runtimerol en de bijbehorende mogelijkheden hebben.
| Scope | Tool | Grenzen |
|---|---|---|
| business-system:discover | dfb_systems dfb_system_describe | Ontdekt alleen systemen die bij deze autorisatie zijn toegekend en momenteel aanroepbaar zijn |
| business-system:read | dfb_query dfb_record dfb_work_items dfb_action_status | Records die de huidige gebruiker mag lezen, en diens eigen plannen |
| business-system:plan | dfb_action_plan | Alleen onveranderlijke plannen maken, niet uitvoeren |
| business-system:execute | dfb_action_execute | Afzonderlijke, expliciete autorisatie; uitvoering volgens risico en goedkeuring |
- dfb_systems ontdekt geautoriseerde systemen.
- dfb_system_describe leest de huidige gepubliceerde contracten, releaseId en alle hashes, query's en commando's.
- dfb_query gebruikt de gepubliceerde queryKey en specificeert indien nodig objectKey, state, page en pageSize. Het is geen willekeurige SQL.
- dfb_record en dfb_work_items lezen de momenteel toegestane records en openstaande taken.
- Geef vóór de uitvoering met dfb_action_plan de werkelijke releaseId, releaseHash, canonicalIrHash, agentManifestHash, commandType, planIdempotencyKey en de contract-payload op.
- Controleer riskClass, requiresApproval en status; bewaar expectedRecordVersion als doelrecords betrokken zijn.
- dfb_action_execute voert alleen plannen uit die bij de huidige verbinding horen en gereed zijn; goedkeuringstokens voor vereiste menselijke goedkeuring worden door DataFocus uitgegeven.
- Na een fout of time-out achterhaalt u met dfb_action_status de stand van het oorspronkelijke plan; nieuwe pogingen behouden de oorspronkelijke idempotentiesemantiek.
Verbinding en versiebinding
Het plan is gebonden aan de stabiele isolatie-id van de huidige Grant. Na vernieuwing van het access token kunnen plannen van dezelfde verbinding nog steeds worden verwerkt; een andere OAuth-verbinding kan deze niet overnemen. Bij uitvoering worden opnieuw gecontroleerd: gepubliceerde versie, IR/manifest-hash, doelrecordversie, planvervaltijd, idempotentie en goedkeuring. Een OAuth-allowlist kan de bedrijfsgovernance niet omzeilen.
Invoer van bedrijfskennis en te bevestigen vragen
Registreer bedrijfsinvoer wanneer de bijbehorende productieprocessor beschikbaar is, en respecteer de grens van menselijke bevestiging.
De volgende vier tools worden door de openbare MCP-controller toegevoegd op basis van geïnstalleerde processors en de huidige scope-voorwaarden. Ze staan niet altijd in de basiscatalogus. Het bestaan van een gedeclareerd Schema betekent niet dat de instantie over alle benodigde processors, budget en rechten beschikt; controleer eerst tools/list.
| Tool | Doel | Wat de tool niet autoriseert of bewerkstelligt |
|---|---|---|
| dfc_ontology_knowledge_input_propose | Oorspronkelijke bedrijfsinvoer registreren voor een bestaande werkruimte | Genereert geen bevestigingsvragen, keurt niets goed, publiceert niet |
| dfc_ontology_knowledge_input_preview | Tijdelijke voorbeeldweergave van conceptvragen op basis van de oorspronkelijke invoer | Niet persistent, niet bevestigd, geen productieontvangstbewijs |
| dfc_ontology_knowledge_question_submit | Opgestelde (authored), nog niet bevestigde vragen opslaan | Voegt antwoorden niet automatisch samen, verkrijgt geen verantwoordelijkheids- of publicatierechten |
| dfc_ontology_business_scope_initialize | Expliciet een consumentenscope voor een bedrijfssysteem initialiseren | Publiceert niet, activeert niet, verleent geen brontoegang |
Invoer en voorbeeldweergave
- Haal workspaceId, workspaceRevision, localRef en preparationDigest uit de daadwerkelijke voorbereidende werkzaamheden.
- propose registreert bedrijfsinvoer met het oorspronkelijke input-contract en een stabiele idempotencyKey; eenzelfde sleutel hoort altijd bij dezelfde invoer.
- preview gebruikt de idempotentiesleutel en ontologyId van de oorspronkelijke invoer; het retourneert telkens een revision van de server en een venster van 60 seconden en is geen idempotent ontvangstbewijs van voltooide productie.
- Moeten vragen worden opgeslagen, dan gebruikt question_submit een nieuwe commandosleutel, de oorspronkelijke originalInputKey, expliciete questionRevision, validFrom, validUntil en expectedRevision; bij het aanmaken is expectedRevision null.
Toegangspunt voor menselijke bevestiging
De knowledgeConfirmationPage die question_submit retourneert, is slechts een relatieve verwijzing binnen de oorspronkelijke inlogpagina die een vraag vooraf invult. Ze bevat geen Bearer, opent niet automatisch de pagina en bevestigt geen kennis. QUESTION_STORED_UNCONFIRMED geeft expliciet aan dat er nog geen bevestiging heeft plaatsgevonden; schrijf in antwoorden dus niet “kennis is gepubliceerd”.
Initialisatie van de consumentenscope
business scope initialize vereist zowel publicatierechten op de ontologie als maker- of SourceManager-beheerrechten op precies dat bedrijfssysteem. Het gebruikt de echte coördinaten van domainRid, domainRevisionId en businessSystemId; de client mag geen willekeurige consumerScope of voltooiingsbewijzen invullen. Ook bij de geretourneerde INITIALIZED en COMPLETED geldt nog steeds expliciet published=false en activationAuthorized=false.
Deze verzoeken doorlopen ook een strikte validatie van JSON, veldenset, bytes en diepte. De invoerlimiet voor verzoeken is 1 MiB; sommige specifieke bewerkingen hebben kleinere limieten. Volledige invoer- en uitvoerschema's worden met de toolreferentie meegeleverd; de soepele parameterlogica van de algemene MCP-wrapper mag niet op deze strikte contracten worden toegepast.
Responsen, fouten en veilig opnieuw proberen
Interpreteer fouten per laag en behoud taakcoördinaten en idempotentiesemantiek.
| Laag | Te controleren inhoud | Verwerkingsprincipe |
|---|---|---|
| Netwerk en HTTP | Verbinding, TLS, 401, 403, 400, 404, 405 enz. | Behandel mislukte responsen niet als gewone queryresultaten |
| JSON-RPC | error.code message data | Onderscheid protocol-, methode-, parameter- en autorisatieproblemen |
| MCP-tool | result.isError en structuredContent | HTTP 200 kan nog steeds een mislukking betekenen |
| Bedrijfsresultaat | Werkelijke status, volledigheid, oorzaak van de fout, nextAction | Ontvangen of gereed is niet gelijk aan voltooid |
| Geschiktheid als feit | executionReceipt citationEligible contentComplete | Niet-geschikte inhoud dient alleen voor lokalisatie of om hiaten te verklaren |
Veelvoorkomende HTTP-situaties
- 401: ontbrekende of verlopen Bearer; vernieuw of autoriseer opnieuw volgens de huidige OAuth-flow.
- 403: Grant, rol, geselecteerde resources, bronrechten, Origin of configuratie voldoen niet; probeer dit niet te omzeilen door het verzoek te herhalen.
- 400: bericht of versiecontract ongeldig, inclusief inconsistentie tussen moderne headers en metadata.
- 404: controleer het exacte servicepad, de protocolmethode en runtime-mogelijkheden; wissel niet willekeurig van ontologie-id.
- 405: GET en DELETE zijn op de openbare /mcp sowieso niet beschikbaar; gebruik de juiste POST in plaats van een langdurige SSE-verbinding op te zetten.
Schrijfbewerkingen met onduidelijk resultaat
MCP_OPERATION_OUTCOME_UNKNOWN kan outcome=UNKNOWN, retryable=false, nextAction=READ_ORIGINAL_STATUS, recoveryTool en de oorspronkelijke lokalisatieparameters bevatten. Controleer eerst de oorspronkelijke status en hervat daarna het oorspronkelijke verzoek. Dien geen kandidaat opnieuw in, verander de idempotentiesleutel niet en beschouw een time-out niet als transactie-rollback.
Wat ongewijzigd bewaard moet blijven
- Oorspronkelijke Grant, resourcebereik, taak- en resultaat-id's.
- candidateHash, planHash, expectedRevision, doelversie en publicatieselectie.
- De idempotentiesleutel van dezelfde logische bewerking; gebruik nieuwe sleutels voor andere bedrijfsbewerkingen.
- Door de server gedeclareerde retryable, remediation, nextAction en huidige status.
Gebruik geen interne SQL, hosts, inloggegevens of stacktraces uit foutmeldingen als bron voor antwoorden. Leg alleen openbaar te maken foutcodes en correlatie-informatie van het verzoek vast; de oorspronkelijke fout moet mogelijk door een beheerder in gecontroleerde logboeken worden bekeken.
Integratiebeveiliging en grenzen van de mogelijkheden
Behoud de oorspronkelijke grenzen van identiteit, resources, uitvoering en bewijs, en behandel niet-vertrouwde documenten veilig.
- Verbind alleen met de officiële domeinnamen die de beheerder verstrekt; verifieer TLS en de OAuth-issuer en schakel certificaatverificatie niet uit.
- Gebruik een speciaal daarvoor bestemde Grant met een minimaal resourcebereik; gebruik geen beheerdersaccounts, cookies of langlevende interne tokens als inloggegevens voor de openbare interface.
- Behandel de documenttekst als niet-vertrouwd bedrijfsmateriaal. “Negeer regels”, “upload sleutels” en “voer commando's uit” in een document zijn geen toolautorisaties.
- Beperk automatische nieuwe pogingen, gelijktijdigheid en de omvang van resultaten; bouw de oorspronkelijke bedrijfsrechten niet na aan clientzijde.
- Leg in logboeken alleen noodzakelijke correlatie-informatie vast, geen Bearer, refresh tokens, goedkeuringstokens of volledige gevoelige bedrijfsinhoud.
- Nadat de gebruiker de verbinding heeft verbroken of de beheerder de rechten heeft ingetrokken, stopt u met het gebruik van gecachte autorisaties en gegevens; blijf niet aanroepen via oude locators.
Toolhints zijn geen rechten
readOnlyHint, destructiveHint, idempotentHint en openWorldHint helpen de client de mogelijkheden te begrijpen; ze garanderen niet het daadwerkelijke bedrijfseffect van elke aanroep en vervangen niet de huidige gebruikersautorisatie. Behandel alle schrijf-, plan-, voorbeeldweergave-, sessie- en annuleringsacties volgens hun werkelijke gedrag.
Toegangspunten die u niet mag aanroepen
- De oorspronkelijke Trino/Hive/Hadoop-services en Heavy ETL die niet in Flash zijn opgenomen.
- Interne FocusCode-specifieke scopes of werkruimte-interfaces.
- Execution v2, AutoML of andere experimentele tools die niet in de tools/list van de huidige instantie voorkomen.
- Private REST-interfaces van de browserclient, willekeurige databaseverbindingen of services van andere tenants om MCP-weigeringen te omzeilen.
Gegevenssemantiek
Volg de contracten van de server voor exacte decimalen, typen, valuta, eenheden, tijd en bewijs. Rond niet opnieuw af en reken geen valuta om alleen omdat de uitvoertekst op een getal lijkt, en maak geen globale ranglijst van zichtbare rijen wanneer resultaten zijn afgekapt.
Beheerdersconfiguratie en voorwaardelijke schakelaars
Controleer vóór het inschakelen van uitgebreide mogelijkheden de werkelijke componenten, openbare adressen en oorspronkelijke rechtenconfiguratie.
| Configuratie | Doel | Vereisten voor go-live |
|---|---|---|
| datafocus.mcp.public-base-url | Officieel extern basisadres | OAuth-discovery, issuer, callbacks en reverse proxy komen overeen |
| datafocus.mcp.allowed-origins | Extra goedgekeurde browserorigins | Exact geconfigureerd, niet uitgebreid naar willekeurige origins |
| datafocus.mcp.oauth.route-proof-secret | Speciaal servergeheim voor bewijzen van graafroutering | Apart opgeslagen, geen Bearer als sleutel |
| datafocus.mcp.analysis.tools.enabled | Interactieve analysetools | Bijbehorende data-, kennis- en rechtendiensten daadwerkelijk beschikbaar |
| datafocus.mcp.analysis.report-tools.enabled | Tools voor persistente rapporten | Bijbehorende opslag, worker en herstelketen beschikbaar |
| datafocus.mcp.analysis.apps.enabled | MCP Apps-weergave | Client declareert ondersteuning en controleert geretourneerde _meta |
| datafocus.mcp.authoring.enabled | Concept- en modelleercontracten | Behoud oorspronkelijke beheerders- en resourcerechten |
| datafocus.mcp.authoring.apply-enabled | Artefacten toepassen | Onveranderlijk plan, oorspronkelijke goedkeuring en hercontrole van de huidige status |
| datafocus.mcp.ontology-published-query-enabled | Gepubliceerde modellen en query's | Werkelijk vastgelegde (committed) versies en bronautorisatie |
| datafocus.mcp.ontology-candidate-query-enabled | Gestructureerde query's op kandidaten | Kandidaateigendom, exacte versie en leesrechten |
| datafocus.mcp.authoring.ontology-auto-publication-enabled | Gedelegeerde autorisaties voor automatische publicatie | Geldig oorspronkelijk beleid, vertrouwen in openbare sleutels, budget en publicatierechten |
Deze namen komen uit r56-configuratie en -implementatie; of ze kunnen worden ingeschakeld hangt af van de bijbehorende diensten en de oorspronkelijke go-live-gates. Alleen een booleaanse waarde wijzigen vult ontbrekende processors, databases, validatiebudgetten of beleid niet aan. De zichtbaarheid van kennisinvoer-uitbreidingen en Pi-taken wordt bepaald door de daadwerkelijk geïnstalleerde componenten.
Edgeproxy
Behoud Authorization, Content-Type, MCP-Protocol-Version, Mcp-Method, Mcp-Name en goedgekeurde Origin. Stel request body, time-outs en TLS in volgens de werkelijke servicevereisten; stuur de openbare /mcp niet door naar een beheerpoort of een ander product.
Go-live-controle
- De status van anonieme discovery en beveiligde aanroepen komt overeen met de verwachtingen.
- Gewone gebruikers ontdekken alleen hun geautoriseerde bereik; na intrekking van de rechten worden volgende verzoeken geweigerd.
- Native Search-sessies, SQL, brontekst en optionele rapporten leveren elk werkelijke resultaten op.
- Goedkeuring en idempotent herstel van schrijf- en publicatieacties behouden het oorspronkelijke gedrag.
- Logboeken en openbare documentatie bevatten geen privésleutels, tokens, cookies, wachtwoorden of interne klantgegevens.
Uitvoerbare client en aanroepvoorbeelden
Valideer berichten met de meegeleverde minimale client, zonder OAuth of de huidige autorisatie te omzeilen.
examples/flash_mcp.py is een minimale protocolclient die alleen afhankelijk is van de Python-standaardbibliotheek. De client logt niet in, verleent geen goedkeuringen namens anderen, roept niet automatisch onzichtbare tools aan, ondersteunt moderne en oude protocollen en sluit af met een aparte exitcode per laag: HTTP, JSON-RPC of toolfout. Tokens worden via de procesomgeving ingevoerd en niet in scripts of documentatie geschreven.
export FLASH_BASE_URL='https://flash.example.com'
read -r -s -p 'Access token: ' FLASH_ACCESS_TOKEN
export FLASH_ACCESS_TOKEN
python3 examples/flash_mcp.py discover
python3 examples/flash_mcp.py tools
python3 examples/flash_mcp.py call dfc_ontologies --arguments '{"page":1,"pageSize":20}'
unset FLASH_ACCESS_TOKENLezen en query's
python3 examples/flash_mcp.py call dfc_ontology_resources \
--arguments-file examples/requests/ontology-resources.json
python3 examples/flash_mcp.py call dfc_table \
--arguments-file examples/requests/table-detail.json
python3 examples/flash_mcp.py call dfc_table \
--arguments-file examples/requests/top3-query.jsonVervang eerst de ONTOLOGY_ID-, TABLE_RESOURCE_ID- en andere placeholders in het verzoekbestand door de echte waarden die door de huidige autorisatie worden geretourneerd. De client weigert uitvoering wanneer placeholders worden aangetroffen. Het SQL-voorbeeld vereist dat de bijbehorende CSV is geïmporteerd met de oorspronkelijke kolomnamen; zonder het bijbehorende schema kan het niet rechtstreeks worden ingediend.
Andere scenario's
- Toegangspunt voor de Business Workspace: gebruik --endpoint business en verkrijg opnieuw een Grant voor /mcp/business.
- Oude client: kies --protocol 2025-11-25, voer eerst initialize uit en roep daarna aan volgens hetzelfde protocol.
- Ingebouwde instructies: gebruik resources of read-resource om de werkelijke URI te lezen.
- Offline zelftest: --self-test verifieert de constructie van moderne headers en metadata, vereist geen token en stuurt geen verzoeken naar de productserver.
Grenzen van het voorbeeld
De client is een startpunt voor protocoltoegang; hij genereert niet automatisch modelleerkandidaten, slaat geen vraag-en-antwoord op en voert geen publicatie uit. Hij geeft de oorspronkelijke JSON weer, zodat de bovenliggende Agent de bedrijfsstatus kan verifiëren; beloof de gebruiker niet alleen op basis van de exitcode van het proces dat een query, rapport of publicatie is voltooid.
Ontologiechatinterface insluiten
Sluit de chatpagina voor mensen in de front-end van een bedrijfsapplicatie in en behoud daarbij de grenzen van login en browserbeveiliging.
<iframe
title="OT Flash ontology agent"
src="https://flash.example.com/10001/#/embed/ontology-agent/1001"
style="width:100%;height:760px;border:0"
referrerpolicy="strict-origin-when-cross-origin">
</iframe>10001 is een voorbeeld-tenant-id en 1001 een voorbeeld-ontologie-id; vervang ze bij gebruik door echte coördinaten waarop u rechten hebt. Een enkele ontologie kan worden opgegeven via path of een ondersteunde queryparameter; in de all-modus kiest de huidige gebruiker met @ een van de ontologieën waartoe hij toegang heeft. skillId wordt alleen doorgegeven; beweer op basis daarvan niet dat skill-orkestratie al uitvoerbaar is.
Authenticatie en domeinnaam
De huidige ingesloten pagina is afhankelijk van een echte DataFocus-loginstatus en controleert /uc/status. Cross-site cookies, SSO, CSP frame-ancestors en gatewayconfiguratie beïnvloeden de insluiting. De pagina accepteert geen MCP Bearer in de URL als manier om zonder login toegang te krijgen; niet-geïmplementeerde outside-links mag u niet zelf samenstellen aan de hand van ontwerpvoorstellen.
Verschil tussen MCP en iframe
| Methode | Gebruiker | Identiteit en resultaat |
|---|---|---|
| Remote MCP | Integratie door externe Agent of service | OAuth Grant en gestructureerde ontvangstbewijzen van tools |
| Ontologiechat-iframe | Menselijke eindgebruiker | Bestaande loginstatus en chatinterface |
| MCP Apps | MCP-client met ondersteuning voor uitbreidingen | Gecontroleerde resources en huidige toolresultaten; geen vervanging voor login via een openbaar iframe |
Acceptatiechecklist voor integratie
Bewijs de volledige bedrijfsketen op een echte instantie, in plaats van alleen te bevestigen dat de interface 200 retourneert.
- Discovery: verkrijg de daadwerkelijk ondersteunde versies, de huidige toolcatalogus en de ingebouwde resources.
- Autorisatie: gewone gebruikers zien alleen de goedgekeurde ontologieën en bedrijfssystemen; bewerkingen zonder scope worden geweigerd.
- Tabelstructuur: werkelijke weergavenamen, kolommen, typen en rechten zijn volledig.
- SQL: controles voor eendimensionale en multidimensionale query's, JOIN, datums, TopN en afkapping stemmen overeen met de werkelijke bedrijfsdefinities.
- Kennis: lokalisatie, volledige brontekst en geschiktheid als feitelijke bron zijn consistent; gemengde vragen hebben zowel een data- als een documentonderbouwing.
- Search: controles van model, init, suggesties, resultaten, afsluiten en buffervolledigheid geslaagd.
- Optionele analyse en rapporten: de werkelijke status van meerdere vertakkingen, paginering, rechtenwijzigingen en annulering behouden het oorspronkelijke gedrag.
- Optionele modellering: kandidaten, plannen, oorspronkelijke goedkeuring, daadwerkelijke toepassing en versiequery fase voor fase geverifieerd.
- Bedrijfsacties: releasehash, doelversie, goedkeuring, idempotentie en isolatie tussen Grants geverifieerd.
- Herstel: na een netwerktime-out wordt de oorspronkelijke status opgehaald; na een bronupdate vervalt de oude lokalisatie en wordt een nieuwe query gebruikt.
Resultatenregistratie
Registreer de instantieversie, gebruikersrol, Grant-bereik, configuratieversie, echte bewerkingen en resultaten. De offline zelftest van de protocolclient, de offline verwachte waarden van de voorbeeld-CSV, de statische JSON Schema-validatie en de echte online functionele acceptatie worden afzonderlijk gemarkeerd. Extrapoleer het slagen van één fase niet naar het slagen van het hele product.
Referentiematerialen en onderhoud
Gebruik de volledige tool-Schema's die bij de handleiding zijn meegeleverd en houd ze gesynchroniseerd met de werkelijke discovery-resultaten van de instantie.
| Bronnen | Inhoud |
|---|---|
| reference/mcp-tool-catalog.json | Gedeclareerde input-Schema's van 32 tools aan ontologiezijde en 8 aan de zijde van de Business Workspace; voor sommige tools ook het oorspronkelijke output-Schema |
| reference/locales.json | 21 selecteerbare opties, 24 compatibele locales en UI-termen |
| reference/search-keywords.json | Statische trefwoordencatalogus voor 17 expliciete locales |
| reference/analysis-contract-manifest.json | Versiebeperkingen voor analyse, vertakkingen, feiten, ontvangstbewijzen en rapporten |
| examples/ | Synthetische CSV, toelichting op definities, Top3-SQL, verwachte resultaten en een minimale protocolclient |
Ingebouwde instructieresources
datafocus://manuals/etl-formulas/v1
datafocus://manuals/search-keyword-queries/v1
datafocus://manuals/etl-functions/v1
datafocus://manuals/search-keywords/v1resources/list en resources/read vereisen dat de huidige gebruiker ten minste één bijbehorende leesbevoegdheid heeft uit metadata, search operate of etl operate. ETL-documentatie is een statische, productoverstijgende referentie; de uitvoerbare mogelijkheden van Flash blijven beperkt tot het bereik dat Flash expliciet rapporteert.
Referentie voor externe protocollen
Voor de MCP-protocol- en autorisatieachtergrond raadpleegt u de officiële specificaties: https://modelcontextprotocol.io/specification/2026-07-28/basic en https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization. De eindpunten, tools en voorwaardelijke gedragingen van dit product zijn gebaseerd op de r56-implementatie en de huidige discovery-resultaten van de instantie; algemene protocolondersteuning mag niet worden gelijkgesteld met het leveren van alle optionele functies door de server.
Upgrade en onderhoud
Ontdek tools en versies opnieuw bij een upgrade en vergelijk input-Schema's, outputcontracten en configuraties; oude Grants verkrijgen niet automatisch nieuwe scopes. Houd referenties, caches en ontvangstbewijzen gebonden aan de bronversie, haal na bevestigde incompatibele wijzigingen de context opnieuw op en pas oude lokalisaties niet geforceerd toe op een nieuwe bedrijfsstatus.
Toolparameterreferentie: basis en native Search
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfc_manual
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| names | array | Optioneel of voorwaardelijk verplicht | De expliciete namen die moeten worden opgezocht, maximaal 32 per keer. maxItems: 32 |
| action | string | Optioneel of voorwaardelijk verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: list, read, keywords, functions, etl_requests |
| locale | string | Optioneel of voorwaardelijk verplicht | Locale van de expliciete statische naslagcatalogus, niet de standaardtaal van de query. |
| uri | string | Optioneel of voorwaardelijk verplicht | URI van een ingebouwde resource die de huidige tool vermeldt. enum: datafocus://manuals/etl-formulas/v1, datafocus://manuals/search-keyword-queries/v1, datafocus://manuals/etl-functions/v1, datafocus://manuals/search-keywords/v1 |
dfc_search
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| data | object | Optioneel of voorwaardelijk verplicht | Oorspronkelijke actiepayload; zie capability discovery en de tabel met actievelden. |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: capabilities, model_create, model_read, open, request, poll, cancel, close |
dfc_etl
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| data | object | Optioneel of voorwaardelijk verplicht | Oorspronkelijke actiepayload; zie capability discovery en de tabel met actievelden. |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: capabilities |
dfc_ontologies
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| pageSize | integer | Optioneel of voorwaardelijk verplicht | Aantal items per pagina; binnen de bovengrens van het Schema. minimum: 1; maximum: 100 |
| page | integer | Optioneel of voorwaardelijk verplicht | Paginanummer, beginnend bij 1. minimum: 1 |
dfc_ontology_resources
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| resourceTypes | array | Optioneel of voorwaardelijk verplicht | Verzameling resourcetypen die moeten worden geretourneerd. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| pageSize | integer | Optioneel of voorwaardelijk verplicht | Aantal items per pagina; binnen de bovengrens van het Schema. minimum: 1; maximum: 100 |
| page | integer | Optioneel of voorwaardelijk verplicht | Paginanummer, beginnend bij 1. minimum: 1 |
Toolparameterreferentie: tabellen, graaf en kennis
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfc_ontology_graph
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| relationTypes | array | Optioneel of voorwaardelijk verplicht | Filter op relatietype. |
| depth | integer | Optioneel of voorwaardelijk verplicht | Diepte van de traversal naar buurknooppunten. minimum: 1; maximum: 3 |
| sourceTypes | array | Optioneel of voorwaardelijk verplicht | Filter op brontype. |
| query | object | Optioneel of voorwaardelijk verplicht | Querytekst, of het exacte geversioneerde queryobject dat bij action hoort. |
| limit | integer | Optioneel of voorwaardelijk verplicht | Bovengrens van het aantal geretourneerde items. minimum: 1; maximum: 100 |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: search, neighbors, published_model, published_query, candidate_query |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| nodeKey | string | Optioneel of voorwaardelijk verplicht | Knooppuntsleutel, gekopieerd uit de werkelijke graafresultaten. |
| keyword | string | Optioneel of voorwaardelijk verplicht | Trefwoord voor lokalisatie in de graaf; geen syntaxis voor trefwoordquery's. |
| nodeTypes | array | Optioneel of voorwaardelijk verplicht | Filter op knooppunttype. |
dfc_ontology_query
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| routeLocators | array | Optioneel of voorwaardelijk verplicht | Volledig gekopieerde, getypeerde routelocator die door de server is uitgegeven. maxItems: 20 |
| topK | integer | Optioneel of voorwaardelijk verplicht | Bovengrens van opgehaalde kandidaten; bewijst geen volledige dekking. minimum: 1; maximum: 20 |
| queryMode | string | Optioneel of voorwaardelijk verplicht | Kies de querymodus voor bewijs uit de enum-waarden van de tool. enum: vector, hybrid, graph |
| fanoutPlan | object | Optioneel of voorwaardelijk verplicht | Begrensd zoekplan per vertakking, volgens het geneste Schema. |
| structuredPlan | object | Optioneel of voorwaardelijk verplicht | Aan het servercontract gebonden plan voor een volledige documenttabel; geen SQL. |
| knowledgeIds | array | Optioneel of voorwaardelijk verplicht | Kennisbank-id uit de werkelijke knowledgeBindings. |
| query | string | Verplicht | Querytekst, of het exacte geversioneerde queryobject dat bij action hoort. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
dfc_knowledge_search
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| topK | integer | Optioneel of voorwaardelijk verplicht | Bovengrens van opgehaalde kandidaten; bewijst geen volledige dekking. minimum: 1; maximum: 20 |
| minScore | number | Optioneel of voorwaardelijk verplicht | Minimale matchscore. minimum: 0; maximum: 1 |
| knowledgeIds | array | Optioneel of voorwaardelijk verplicht | Kennisbank-id uit de werkelijke knowledgeBindings. |
| query | string | Verplicht | Querytekst, of het exacte geversioneerde queryobject dat bij action hoort. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| assetIds | array | Optioneel of voorwaardelijk verplicht | Momenteel toegestane documentasset-id's. |
| retrievalStrategy | string | Optioneel of voorwaardelijk verplicht | Daadwerkelijk ondersteunde zoekstrategie. enum: auto, hybrid_stage2 |
dfc_knowledge_detail
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| qdrantId | string / integer | Optioneel of voorwaardelijk verplicht | Indexidentificatie die door de werkelijke lokalisatie is geretourneerd. |
| pageNo | integer | Optioneel of voorwaardelijk verplicht | Werkelijke pagina of paginanummer. |
| evidenceId | string | Optioneel of voorwaardelijk verplicht | Bewijs-id die door dezelfde kennislokalisatie is geretourneerd. |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: chunk, document, page_context |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| documentId | string / integer | Optioneel of voorwaardelijk verplicht | Document-id uit dezelfde lokalisatie. |
| radius | integer | Optioneel of voorwaardelijk verplicht | Bereik van aangrenzende pagina's. minimum: 0; maximum: 3 |
| chunkId | string | Optioneel of voorwaardelijk verplicht | Werkelijke chunk-id uit dezelfde lokalisatie. |
dfc_table
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| maxRows | integer | Optioneel of voorwaardelijk verplicht | Bovengrens van het aantal geretourneerde rijen; geen rangschikkingsbereik aan clientzijde. minimum: 1; maximum: 200 |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: detail, query |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| id | string | Optioneel of voorwaardelijk verplicht | Echte tabelresource-id, geen fysieke naam of weergavenaam. |
| sql | string | Optioneel of voorwaardelijk verplicht | Eén alleen-lezen Doris-SQL-instructie binnen het bereik van de ontologie, met expliciete uitvoerkolommen. |
Toolparameterreferentie: analyse en rapporten
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfc_analysis_ask
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| question | string | Verplicht | Vraag in natuurlijke taal of compatibele vervolgvraag. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| language | string | Optioneel of voorwaardelijk verplicht | Expliciete antwoord- of query-locale; bij weglating volgens de regels van de betreffende tool. |
| sessionId | string | Optioneel of voorwaardelijk verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
dfc_analysis_refine
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| branchId | string | Optioneel of voorwaardelijk verplicht | Door de server uitgegeven verwijzing naar een gestructureerde vertakking. |
| resultId | string | Verplicht | Verwijzing naar het eerder geretourneerde analyseresultaat. |
| question | string | Optioneel of voorwaardelijk verplicht | Vraag in natuurlijke taal of compatibele vervolgvraag. |
| idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| change | object | Optioneel of voorwaardelijk verplicht | Wijziging in natuurlijke taal of getypeerde filter_patch. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| language | string | Optioneel of voorwaardelijk verplicht | Expliciete antwoord- of query-locale; bij weglating volgens de regels van de betreffende tool. |
| sessionId | string | Verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
| expectedRevision | integer | Verplicht | Versievoorwaarde van het oorspronkelijke resultaat of de bedrijfsheader; mag null zijn bij het aanmaken van een vraag. minimum: 1 |
| visualId | string | Optioneel of voorwaardelijk verplicht | Aan de vertakking gebonden verwijzing naar een visualisatie. |
dfc_analysis_page
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| branchId | string | Verplicht | Door de server uitgegeven verwijzing naar een gestructureerde vertakking. |
| resultId | string | Verplicht | Verwijzing naar het eerder geretourneerde analyseresultaat. |
| pageNo | integer | Verplicht | Werkelijke pagina of paginanummer. minimum: 1; maximum: 10000 |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| pageSize | integer | Verplicht | Aantal items per pagina; binnen de bovengrens van het Schema. minimum: 1; maximum: 100 |
| sessionId | string | Verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
| expectedRevision | integer | Verplicht | Versievoorwaarde van het oorspronkelijke resultaat of de bedrijfsheader; mag null zijn bij het aanmaken van een vraag. minimum: 1 |
dfc_analysis_result_get
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| resultId | string | Verplicht | Verwijzing naar het eerder geretourneerde analyseresultaat. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| sessionId | string | Verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
dfc_analysis_cancel
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| resultId | string | Verplicht | Verwijzing naar het eerder geretourneerde analyseresultaat. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| sessionId | string | Verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
dfc_analysis_close
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| sessionId | string | Verplicht | Echte sessieverwijzing binnen dezelfde Grant. |
dfc_report_create
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| goal | string | Verplicht | Analysedoel van het rapport. |
| idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| language | string | Optioneel of voorwaardelijk verplicht | Expliciete antwoord- of query-locale; bij weglating volgens de regels van de betreffende tool. |
| title | string | Optioneel of voorwaardelijk verplicht | Optionele rapporttitel. |
dfc_report_status
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| reportId | string | Verplicht | Verwijzing naar een persistent rapport binnen de huidige Grant. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
dfc_report_cancel
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| reportId | string | Verplicht | Verwijzing naar een persistent rapport binnen de huidige Grant. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
Toolparameterreferentie: modellering en oorspronkelijke taken
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfc_ontology_agent
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| mode | string | Optioneel of voorwaardelijk verplicht | QUERY of AUTHORING; elke modus wordt afzonderlijk geautoriseerd. enum: QUERY, AUTHORING |
| instruction | string | Optioneel of voorwaardelijk verplicht | Tekst met de vraag van de gebruiker; gelijk houden tussen context en indiening. maxLength: 16000 |
| idempotencyKey | string | Optioneel of voorwaardelijk verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. maxLength: 128 |
| action | string | Verplicht | Naam van de bewerking. Gebruik de huidige enum-waarden en de parameters die bij de actie horen. enum: start, status, cancel |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| runId | string | Optioneel of voorwaardelijk verplicht | Oorspronkelijke taak-id binnen dezelfde ontologie en Grant. |
| contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. enum: ontology-agent-task-v1 |
dfc_authoring_capabilities
Het input-rootobject van deze tool heeft geen velden; gebruik een leeg arguments-object.
dfc_artifact_context
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: CONTROL_PANEL_SPEC, VIEW_SPEC |
| scopeType | string | Optioneel of voorwaardelijk verplicht | Het bereiktype voor resources in het daadwerkelijke artefactcontract. |
| ontologyId | string | Optioneel of voorwaardelijk verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| projectId | string | Optioneel of voorwaardelijk verplicht | De momenteel geautoriseerde project-id. |
| artifactId | string | Optioneel of voorwaardelijk verplicht | De echte id van het bestaande artefact dat wordt bewerkt. |
| instruction | string | Verplicht | Tekst met de vraag van de gebruiker; gelijk houden tussen context en indiening. |
| variables | object | Optioneel of voorwaardelijk verplicht | Het variabelenobject zoals aangeleverd door het geretourneerde contract. |
| previewInput | object | Optioneel of voorwaardelijk verplicht | Begrensde invoer voor de voorbeeldweergave, volgens het contract. |
| viewport | object | Optioneel of voorwaardelijk verplicht | De weergaveviewport zoals vereist door het oorspronkelijke contract. |
dfc_ontology_table_schema
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| sourceAssetRef | string | Verplicht | De geregistreerde gestructureerde assetreferentie, bijvoorbeeld table:123. |
| fields | array | Verplicht | De velden van de huidige bron en optionele expliciete typeaanduidingen. minItems: 1; maxItems: 64 |
dfc_artifact_preview
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| proposalId | string | Verplicht | Id van de oorspronkelijke kandidaat die onder de huidige Grant is aangemaakt. |
| candidateHash | string | Verplicht | De exacte hash van de oorspronkelijke kandidaat op de server. |
| previewInput | object | Verplicht | Begrensde invoer voor de voorbeeldweergave, volgens het contract. |
dfc_artifact_status
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| proposalId | string | Optioneel of voorwaardelijk verplicht | Id van de oorspronkelijke kandidaat die onder de huidige Grant is aangemaakt. |
| planId | string | Optioneel of voorwaardelijk verplicht | Id van het onveranderlijke toepassingsplan. |
dfc_artifact_plan
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| proposalId | string | Verplicht | Id van de oorspronkelijke kandidaat die onder de huidige Grant is aangemaakt. |
| candidateHash | string | Verplicht | De exacte hash van de oorspronkelijke kandidaat op de server. |
| expectedTargetVersion | integer | Verplicht | Voorwaarde: de huidige werkelijke doelversie. minimum: 0 |
| idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
dfc_artifact_apply
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| planId | string | Verplicht | Id van het onveranderlijke toepassingsplan. |
| planHash | string | Verplicht | De hash die door het oorspronkelijke plan is geretourneerd. |
| approvalToken | string | Verplicht | Goedkeuringsmateriaal dat de oorspronkelijke server heeft uitgegeven; genereer dit nooit zelf. |
| idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
dfc_artifact_submit
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| Configuratie1 / artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: CONTROL_PANEL_SPEC, VIEW_SPEC |
| Configuratie1 / scopeType | string | Optioneel of voorwaardelijk verplicht | Het bereiktype voor resources in het daadwerkelijke artefactcontract. |
| Configuratie1 / ontologyId | string | Optioneel of voorwaardelijk verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| Configuratie1 / projectId | string | Optioneel of voorwaardelijk verplicht | De momenteel geautoriseerde project-id. |
| Configuratie1 / artifactId | string | Optioneel of voorwaardelijk verplicht | De echte id van het bestaande artefact dat wordt bewerkt. |
| Configuratie1 / instruction | string | Verplicht | Tekst met de vraag van de gebruiker; gelijk houden tussen context en indiening. |
| Configuratie1 / variables | object | Optioneel of voorwaardelijk verplicht | Het variabelenobject zoals aangeleverd door het geretourneerde contract. |
| Configuratie1 / previewInput | object | Optioneel of voorwaardelijk verplicht | Begrensde invoer voor de voorbeeldweergave, volgens het contract. |
| Configuratie1 / viewport | object | Optioneel of voorwaardelijk verplicht | De weergaveviewport zoals vereist door het oorspronkelijke contract. |
| Configuratie1 / contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. |
| Configuratie1 / contextHash | string | Verplicht | De volledige contexthash die context heeft geretourneerd. |
| Configuratie1 / baseArtifactHash | string | Verplicht | De hash van het basisartefact die context heeft geretourneerd. |
| Configuratie1 / baseArtifactVersion | integer | Verplicht | De basisversie die context heeft geretourneerd. minimum: 0 |
| Configuratie1 / candidate | object | Verplicht | Het kandidaatobject conform het huidige geretourneerde contract. |
| Configuratie1 / clientRequestId | string | Verplicht | De stabiele idempotentiesleutel van de client voor het huidige kandidaatverzoek. |
| Configuratie2 / artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: ONTOLOGY_RELEASE |
| Configuratie2 / contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. enum: ontology-publication-mcp-submit-v1, ontology-publication-mcp-submit-v2, ontology-publication-mcp-submit-v3, ontology-publication-mcp-submit-v4, ontology-publication-mcp-submit-v5, ontology-publication-mcp-submit-v6 |
| Configuratie2 / ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| Configuratie2 / candidateHash | string | Verplicht | De exacte hash van de oorspronkelijke kandidaat op de server. |
| Configuratie2 / workspaceId | string | Verplicht | De werkelijke coördinaten van de kandidaatwerkruimte. |
| Configuratie2 / workspaceRevision | string | Verplicht | De exacte kandidaatversie; gebruik geen latest. |
| Configuratie2 / releases | object | Verplicht | De exacte versieselectie volgens het publicatiecontract van de ontologie. |
| Configuratie2 / selection | object | Verplicht | Geef alleen expliciete coördinaten van de bedrijfsselectie op; geen rechten of voltooiingsbewijzen. |
| Configuratie2 / idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| Configuratie3 / Configuratie1 / artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: ONTOLOGY_RELEASE |
| Configuratie3 / Configuratie1 / contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. enum: ontology-workspace-create-mcp-submit-v1 |
| Configuratie3 / Configuratie1 / ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| Configuratie3 / Configuratie1 / workspaceId | string | Verplicht | De werkelijke coördinaten van de kandidaatwerkruimte. |
| Configuratie3 / Configuratie1 / resources | array | Verplicht | Oorspronkelijke modeldeclaraties die de server compileert. minItems: 1 |
| Configuratie3 / Configuratie1 / idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| Configuratie3 / Configuratie2 / artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: ONTOLOGY_RELEASE |
| Configuratie3 / Configuratie2 / contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. enum: ontology-workspace-create-mcp-submit-v2 |
| Configuratie3 / Configuratie2 / ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| Configuratie3 / Configuratie2 / workspaceId | string | Verplicht | De werkelijke coördinaten van de kandidaatwerkruimte. |
| Configuratie3 / Configuratie2 / resources | array | Verplicht | Oorspronkelijke modeldeclaraties die de server compileert. minItems: 1 |
| Configuratie3 / Configuratie2 / idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| Configuratie3 / Configuratie2 / releaseSelections | object | Verplicht | De exacte releaseId van elke gepubliceerde verwijzing en de afsluiting van de afhankelijkheden. |
| Configuratie4 / artifactType | string | Verplicht | Werkelijk ingeschakeld artefact- of ontologiepublicatietype. enum: ONTOLOGY_RELEASE |
| Configuratie4 / contractVersion | string | Verplicht | Gebruik de exacte contractversie die daadwerkelijk wordt ondersteund. enum: ontology-initial-activation-retirement-submit-v1 |
| Configuratie4 / ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| Configuratie4 / domainRid | string | Verplicht | De RID van het echte bedrijfsdomein. |
| Configuratie4 / consumerScopes | array | Verplicht | De exacte consumentenscopes die de server toestaat. minItems: 1; maxItems: 256 |
| Configuratie4 / idempotencyKey | string | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
Toolparameterreferentie: kennisinvoer en bereik
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfc_ontology_knowledge_input_propose
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| request | object | Verplicht | Het oorspronkelijke verzoek met bedrijfsinvoer; volgens het volledige geneste Schema. |
| idempotencyKey | string | Verplicht | De idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. minLength: 1; maxLength: 128 |
Deze tool heeft daarnaast een native outputSchema. Controleer de volledigheid en status van de output en de autorisatievelden die expliciet op false staan; ken voltooiing niet zelf een ruimere betekenis toe.
dfc_ontology_knowledge_input_preview
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| idempotencyKey | string | Verplicht | De idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. minLength: 1; maxLength: 128 |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
Deze tool heeft daarnaast een native outputSchema. Controleer de volledigheid en status van de output en de autorisatievelden die expliciet op false staan; ken voltooiing niet zelf een ruimere betekenis toe.
dfc_ontology_knowledge_question_submit
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| questionRevision | $ref | Verplicht | De expliciete versie van de te bevestigen vraag. |
| idempotencyKey | $ref | Verplicht | Idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. |
| originalInputKey | $ref | Verplicht | De idempotentiesleutel die overeenkomt met de oorspronkelijke kennisinvoer. |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. |
| validUntil | $ref | Verplicht | Einde van het geldigheidsvenster van de vraag, in UTC. |
| expectedRevision | oneOf | Verplicht | Versievoorwaarde van het oorspronkelijke resultaat of de bedrijfsheader; mag null zijn bij het aanmaken van een vraag. |
| validFrom | $ref | Verplicht | Begin van het geldigheidsvenster van de vraag, in UTC. |
Deze tool heeft daarnaast een native outputSchema. Controleer de volledigheid en status van de output en de autorisatievelden die expliciet op false staan; ken voltooiing niet zelf een ruimere betekenis toe.
dfc_ontology_business_scope_initialize
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| domainRevisionId | string | Verplicht | De exacte versie van het bedrijfsdomein. minLength: 1; maxLength: 128 |
| idempotencyKey | string | Verplicht | De idempotentiesleutel die stabiel wordt hergebruikt voor dezelfde logische bewerking. minLength: 1; maxLength: 128 |
| businessSystemId | string | Verplicht | De echte id van het bedrijfssysteem. minLength: 1 |
| ontologyId | string | Verplicht | Echte ontologie-id binnen deze autorisatie, als tekenreeks bewaard. minLength: 1 |
| domainRid | string | Verplicht | De RID van het echte bedrijfsdomein. minLength: 1; maxLength: 128 |
Deze tool heeft daarnaast een native outputSchema. Controleer de volledigheid en status van de output en de autorisatievelden die expliciet op false staan; ken voltooiing niet zelf een ruimere betekenis toe.
Toolparameterreferentie: Business Workspace
Volledige namen en invoervelden, per tool gegroepeerd.
De volgende tabellen dienen als naslag voor de invoervelden van de huidige r56-tools. Zie reference/mcp-tool-catalog.json voor volledige geneste typen, oneOf, voorwaardelijk verplichte velden, patroonbeperkingen en een deel van de output-Schema's; lees vóór het definitief indienen altijd de tools/list van de huidige Grant. “Optioneel” in de tabellen heft de interne validatie-eisen van acties niet op.
dfb_systems
Het input-rootobject van deze tool heeft geen velden; gebruik een leeg arguments-object.
dfb_system_describe
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| systemId | string / integer | Verplicht | Systeem-id die de huidige Grant voor bedrijfssystemen toestaat. |
dfb_query
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| systemId | string / integer | Verplicht | Systeem-id die de huidige Grant voor bedrijfssystemen toestaat. |
| queryKey | string | Verplicht | De gepubliceerde querysleutel geretourneerd door describe. |
| objectKey | string | Optioneel of voorwaardelijk verplicht | De gepubliceerde objectsleutel. |
| pageSize | integer | Optioneel of voorwaardelijk verplicht | Aantal items per pagina; binnen de bovengrens van het Schema. minimum: 1; maximum: 100 |
| page | integer | Optioneel of voorwaardelijk verplicht | Paginanummer, beginnend bij 1. minimum: 1 |
| state | string | Optioneel of voorwaardelijk verplicht | Filter op bedrijfsstatus of serverstatus. |
dfb_record
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| recordId | string / integer | Verplicht | Id van een bedrijfsrecord dat momenteel mag worden gelezen. |
| systemId | string / integer | Verplicht | Systeem-id die de huidige Grant voor bedrijfssystemen toestaat. |
dfb_work_items
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| systemId | string / integer | Verplicht | Systeem-id die de huidige Grant voor bedrijfssystemen toestaat. |
dfb_action_plan
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| expectedRecordVersion | integer | Optioneel of voorwaardelijk verplicht | Huidige versie voor optimistische vergrendeling van het doelrecord. minimum: 1 |
| systemId | string / integer | Verplicht | Systeem-id die de huidige Grant voor bedrijfssystemen toestaat. |
| commandType | string | Verplicht | Het opdrachttype uit het gepubliceerde contract. |
| canonicalIrHash | string | Verplicht | De hash van de momenteel gepubliceerde canonieke IR. |
| releaseId | string / integer | Verplicht | De werkelijke versie-id van het gepubliceerde contract. |
| payload | object | Verplicht | De payload conform het huidige opdrachtcontract in describe. |
| releaseHash | string | Verplicht | De werkelijke hash van het gepubliceerde contract. |
| targetRecordId | string / integer | Optioneel of voorwaardelijk verplicht | Het echte doelrecord waarop de bewerking betrekking heeft. |
| agentManifestHash | string | Verplicht | De werkelijke hash van het manifest met Agent-mogelijkheden. |
| planIdempotencyKey | string | Verplicht | De stabiele idempotentiesleutel van het bedrijfsplan. |
dfb_action_status
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| actionPlanId | string / integer | Verplicht | Id van het actieplan dat bij de huidige Grant voor bedrijfssystemen hoort. |
dfb_action_execute
| Parameter | Type | Vereiste | Betekenis en bereik |
|---|---|---|---|
| approvalToken | string | Optioneel of voorwaardelijk verplicht | Goedkeuringsmateriaal dat de oorspronkelijke server heeft uitgegeven; genereer dit nooit zelf. |
| actionPlanId | string / integer | Verplicht | Id van het actieplan dat bij de huidige Grant voor bedrijfssystemen hoort. |