DATAFOCUS · OT FLASH · R56

Manual de integração do Agent e do MCP do OT Flash

Protocolo, autorização, contratos de ferramentas e fluxo completo de chamada

Construa aplicações de dados e conhecimento rastreáveis usando o Remote MCP público do OT Flash r56. Este manual apresenta OAuth, mensagens de protocolo, referência de parâmetros de todas as ferramentas declaradas, regras de evidência, capacidades condicionais e fluxos de recuperação, além de exemplos de cliente executável e dados sintéticos.

Desenvolvedores de Agent, engenheiros de integração e administradores

Os exemplos complementares mantêm em chinês os nomes de exibição dos campos. A tradução da interface e do texto explicativo não altera nomes reais de tabelas, colunas, valores de enumeração, nomes de ferramentas ou campos de protocolo.

Capítulo 1

Escopo de integração do Agent e critérios de conclusão

Selecione o ponto de entrada de autorização e execute consultas, coleta de evidências ou gravações controladas com base nos recibos do servidor.

O OT Flash r56 fornece capacidades de dados e conhecimento no escopo da ontologia a Agents externos por meio do Remote MCP, além de um ponto de entrada independente para o espaço de trabalho de negócio. O Agent deve definir o trabalho executável com base no tools/list real, no inputSchema, no OAuth scope e nas permissões de recursos atuais; não deve inferir, a partir de um manual estático, que uma implantação já habilitou todas as funcionalidades opcionais.

Figura A1 Uso das capacidades originais de consulta, conhecimento e negócio por um Agent externo por meio de OAuth e MCP. Diagrama de relações de interface.
EntradaFinalidadeLimites
/mcpOntologia, tabelas de dados, conhecimento documental, Search nativo e análise e modelagem disponibilizadas condicionalmenteInterseção entre as permissões do usuário atual e os recursos concedidos nesta autorização
/mcp/businessDescoberta de sistemas de negócio, consultas, planos de ação, status e execuçãoAutorização independente de sistemas de negócio e contratos publicados
Página de incorporação do agente de ontologiaUsar a conversa de ontologia na interface para usuários humanosDepende de uma sessão de login real; não é um ponto de entrada para trocar Token MCP sem login

Classificação de capacidades

  • Leitura básica: ontologia e recursos, localização no grafo, recuperação de conhecimento e texto original completo, detalhes de tabelas autorizadas e Doris SQL.
  • Delegação independente: dfc_search requer search:operate e continua usando as permissões originais do usuário e do modelo.
  • Disponibilidade condicional: análises, relatórios persistentes, rascunho e aplicação de artefatos, consultas ao modelo de ontologia e tarefas delegadas ao Agent.
  • Capacidades indisponíveis: o dfc_etl do Flash apenas reporta capabilities e não fornece execução de ETL do Heavy. O AutoML e os pontos de entrada internos de workspace do FocusCode não fazem parte da API pública do Flash descrita neste manual.

Critérios de conclusão

A leitura de fatos exige um recibo de consulta efetivamente utilizável ou de texto original completo; a geração de candidatos exige declarar que eles ainda não foram aplicados; a publicação exige um recibo real de APPLIED; o cancelamento exige distinguir entre solicitação e confirmação. O texto da resposta, um HTTP 200, a aceitação pela ferramenta ou uma descrição de "concluído" dada pelo modelo não provam, isoladamente, o sucesso de uma operação de negócio.

O arquivo complementar reference/mcp-tool-catalog.json é a referência offline das declarações do r56; ele inclui definições habilitadas condicionalmente e não é o tools/list em tempo real de nenhum usuário. O catálogo completo inclui 28 ferramentas centrais de ontologia, 4 extensões condicionais de controlador e 8 ferramentas do lado do negócio, o que não significa que todas estejam habilitadas por padrão.

Capítulo 2

Conexão rápida e descoberta de capacidades

Comece pelo domínio oficial da instância e descubra as ferramentas realmente disponíveis com privilégios mínimos.

  1. Obtenha com o administrador o endereço raiz HTTPS oficial e a ontologia ou o sistema de negócio que precisam ser acessados. Não use os domínios de exemplo da documentação em chamadas a operações de negócio reais.
  2. Configure o endereço do servidor MCP como https://flash.example.com/mcp; o espaço de trabalho de negócio usa /mcp/business no mesmo domínio.
  3. Acione o login e a autorização do OAuth conforme o suporte do cliente e verifique recursos e scope; não envie nome de usuário e senha ao MCP.
  4. Use a descoberta ou a inicialização da geração de protocolo correspondente e, em seguida, leia o tools/list e as descrições dos recursos.
  5. Faça primeiro uma pequena solicitação somente leitura, verifique os resultados estruturados e os erros e só então execute o objetivo do usuário.

Trecho de configuração do cliente

json
{
  "mcpServers": {
    "ot-flash": {
      "url": "https://flash.example.com/mcp"
    }
  }
}

Este trecho ilustra a intenção de configuração do endereço do servidor; a estrutura específica do arquivo de configuração e o suporte a OAuth dependem do cliente. Não insira access_token, refresh_token, Cookie ou senhas de administrador reais em arquivos públicos.

Descoberta de protocolo moderno

http
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": {}
    }
  }
}

Verificações antes da integração

  • O endereço raiz do recurso, o issuer do OAuth e o endereço externo do proxy reverso coincidem.
  • O cliente oferece suporte à geração de protocolo correspondente, em vez de sempre enviar initialize ao ponto de entrada do protocolo novo.
  • A autorização atual está vinculada à ontologia ou ao sistema de negócio necessário.
  • O Token é válido e os novos scopes opcionais receberam autorização explícita.
Capítulo 3

OAuth: descoberta, registro e autorização

Use o código de autorização e PKCE; não exponha as credenciais de login do produto ao Agent.

Figura A2 Fluxo de código de autorização OAuth e PKCE. Diagrama de sequência.
EndpointMétodoFunção
/.well-known/oauth-protected-resourceGETDescoberta do recurso MCP de ontologia
/.well-known/oauth-protected-resource/mcpGETDescoberta compatível pelo caminho do recurso de ontologia
/.well-known/oauth-protected-resource/mcp/businessGETDescoberta do recurso MCP de negócio
/.well-known/oauth-authorization-serverGETMetadados do servidor de autorização
/oauth/registerPOST JSONRegistro dinâmico de public client
/oauth/authorizeGET ou formulário POSTLogin, seleção do recurso e confirmação da autorização
/oauth/tokenPOST formTroca do código de autorização e renovação com rotação
/oauth/revokePOST formRevogação de Token
/oauth/grantsGETUsuário autenticado visualiza conexões autorizadas
/oauth/grants/revokePOST formRevogar a conexão seguindo o fluxo da página original

Ordem de autorização

  1. Leia os metadados do recurso protegido e os metadados do servidor de autorização. Uma solicitação sem Token retorna 401, e o cabeçalho WWW-Authenticate aponta para o endereço de descoberta de recursos.
  2. Registre ou use uma identidade de cliente. O registro dinâmico de public client do r56 usa token_endpoint_auth_method=none; um segredo de cliente não pode substituir PKCE.
  3. Gere state e code_verifier aleatórios e calcule o code_challenge S256.
  4. Abra o endereço authorize indicado nos metadados, passando response_type=code, client_id, redirect_uri exato, scope, resource, state, code_challenge e code_challenge_method=S256.
  5. O usuário faz login no DataFocus e seleciona a ontologia ou o sistema de negócio. O cliente não pode pré-selecionar recursos que o usuário não tem permissão para acessar.
  6. Receba o callback, valide state e issuer; troque o código de autorização usando o code_verifier original.
  7. Use o access_token apenas para autenticação Bearer de MCP. A renovação usa o fluxo original de OAuth; guarde com segurança o refresh_token rotacionado.

Exemplo de registro

json
{
  "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"]
}

O callback do cliente web usa HTTPS; clientes nativos podem usar endereços de loopback suportados. Tanto a autorização quanto a troca de Token exigem correspondência exata com o callback registrado. Cada Grant se destina a um único protected resource; não misture scopes de ontologia e do espaço de trabalho de negócio na mesma conexão.

Ciclo de vida dos Tokens

No servidor do r56, por padrão, o access token é de 3600 segundos, o refresh token de 2592000 segundos e o código de autorização de 300 segundos; a implantação pode sobrescrever esses valores. O cliente deve se basear no expires_in da resposta do token e nos erros reais, sem fixar os valores padrão no código. Atualize o Token após a renovação; revogar um papel, uma permissão de recurso ou um Grant fará com que chamadas subsequentes sejam rejeitadas.

Capítulo 4

Scope, limites de recursos e permissões em tempo real

O escopo de autorização delega as permissões existentes, não concede elevação de papéis e não compartilha estado de negócio entre Grants.

ScopeCapacidades típicasRestrições importantes
ontology.metadata:readOntologia, recursos, estrutura de tabelasA ontologia e as tabelas devem estar no escopo autorizado e entre o que o usuário pode ler no momento
ontology.graph:readPesquisa no grafo e vizinhosRetorna informações de localização, não evidências de fatos
ontology.knowledge:readLocalização de conhecimento e texto original completoPreserva as permissões originais das bases de conhecimento e dos documentos
ontology.table:querySQL de tabelas da ontologia e consulta a modelos publicadosA consulta de tabelas também exige scope de metadata; as permissões das fontes reais e das colunas continuam valendo
search:operateModelos nativos de palavras-chave e sessõesDelegação independente e explícita, executada conforme as permissões originais do modelo e as permissões de tabela e coluna do usuário
etl:operatecapabilities de ETL do FlashNão disponibiliza o ETL do Heavy
authoring.contract:readContratos de modelagem disponibilizados condicionalmenteTambém exige a opção de funcionalidade habilitada e os recursos correspondentes
authoring.artifact:readLeitura de candidatos, planos etc. com a autorização atualVinculada ao principal, ao Grant e aos recursos originais
authoring.artifact:draftEnvio de candidatos, pré-visualização etc.Não autoriza execução nem publicação
authoring.artifact:applyPlanejamento e aplicação controladosContinua exigindo o papel de negócio, as políticas e as aprovações originais
execution.script:draftRascunhos de scripts específicosNão autoriza a execução real de scripts
datasource.http:read / draft / test / importCapacidades de artefatos de fontes de dados HTTP disponibilizadas condicionalmenteCada item tem sua própria opção e mantém as permissões originais
Figura A3 As permissões do usuário, o Grant, os recursos selecionados e a configuração de funcionalidades determinam em conjunto as capacidades disponíveis. Diagrama ilustrativo.

Requisitos combinados de leitura

dfc_table detail exige ontology.metadata:read; query exige também ontology.table:query. dfc_ontology_query exige os dois scopes de leitura, graph e knowledge. dfc_knowledge_search/detail exige knowledge. published_model/published_query usam table:query; candidate_query também precisa de authoring.artifact:read. As ferramentas de análise também verificam os scopes de evidência permitidos; relatórios persistentes exigem metadata e table query.

Não fixe no código as autorizações padrão

O conjunto padrão de scopes de ontologia do r56 inclui table query; Search e ETL são delegações explícitas. O que vale, no fim, são os metadados de descoberta, a página de autorização, o scope real do Token e o tools/list. As afirmações de documentos antigos, como "a ontologia nunca tem SQL por padrão" ou "existem apenas seis ferramentas", não podem ser tomadas como base da implementação atual.

Isolamento de estado

Sessões, relatórios, candidatos e planos de ação têm seus próprios proprietários e escopos. A renovação do access token não transfere o trabalho de um Grant original para outro Grant. Não mescle na conexão atual sessionId, reportId, planId, tokens de aprovação ou Tokens de origem retornados por outra conexão.

Capítulo 5

Mensagens HTTP e do MCP moderno

Envie corretamente os metadados de cada solicitação e os cabeçalhos de rota correspondentes e trate separadamente os resultados HTTP e os resultados de ferramentas.

ItemComportamento no r56
TransporteStreamable HTTP sem estado, POST JSON-RPC
Versões suportadas2026-07-28, além de 2025-11-25, 2025-06-18 e 2025-03-26
Métodos modernosserver/discover, tools/list, tools/call, resources/list, resources/read, disponibilizados conforme as capacidades reais
Cabeçalho de sessãoNão atribui Mcp-Session-Id
GET e DELETE/mcp e /mcp/business retornam 405
Notificações SSE do servidorNão são fornecidas por estes dois pontos de entrada MCP públicos
Cache do catálogoA descoberta moderna e as listagens retornam ttlMs=60000 e cacheScope=private
Resultado comumOs resultados modernos contêm resultType=complete e metadados de identidade do serviço

Valores que devem coincidir

  • MCP-Protocol-Version corresponde a io.modelcontextprotocol/protocolVersion em params._meta.
  • Mcp-Method corresponde ao método JSON-RPC.
  • Mcp-Name de tools/call corresponde a params.name; o cabeçalho de nome de resources/read corresponde à URI.
  • Cada requisição moderna carrega um objeto io.modelcontextprotocol/clientCapabilities; forneça também o clientInfo padrão para facilitar a identificação do cliente.

Exemplo de chamada

json
{
  "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": {}
    }
  }
}

Os cabeçalhos HTTP correspondentes são Mcp-Method: tools/call e Mcp-Name: dfc_ontologies. Em todos os exemplos, ACCESS_TOKEN é um placeholder. Não coloque o Bearer Token em URLs, parâmetros JSON ou chaves de cache.

Leitura de resultados

Trate primeiro o status HTTP e depois verifique o error do JSON-RPC; quando houver result, verifique também isError. Resultados de ferramenta bem-sucedidos normalmente fornecem structuredContent, junto com um conteúdo text que traz o mesmo JSON de negócio; leia preferencialmente o canal estruturado e não some text e structuredContent como se fossem dois fatos independentes. Um HTTP 200 pode conter falhas de ferramenta.

Recursos públicos e UI

Os recursos de documentação integrados não dependem de MCP Apps. Isso não dá ao ponto de entrada do espaço de trabalho de negócio acesso aos recursos de documentação da ontologia. Clientes com suporte à visualização devem descobrir a UI correspondente por meio das capacidades reais e do _meta das ferramentas, sem adivinhar URIs de recursos não retornados.

Capítulo 6

Compatibilidade com clientes de protocolo legado

Mantenha uma geração de protocolo consistente em clientes que ainda usam o handshake de inicialização.

json
{
  "jsonrpc": "2.0", "id": 1, "method": "initialize",
  "params": {
    "protocolVersion": "2025-11-25",
    "capabilities": {},
    "clientInfo": {"name": "flash-legacy-client", "version": "1.0.0"}
  }
}
  1. Envie initialize e leia a versão de protocolo e as capabilities negociadas pelo servidor.
  2. Envie a notificação de inicialização concluída exigida pelo protocolo do cliente; a notificação não retorna um resultado comum de ferramenta.
  3. Use tools/list para ler as ferramentas atualmente autorizadas e depois envie tools/call.
  4. Mantenha os cabeçalhos e as mensagens coerentes com a geração de protocolo da requisição atual; não use os fluxos antigos de initialize ou ping em mensagens 2026-07-28.

O protocolo legado usa o mesmo Bearer/OAuth, permissões e contratos de ferramenta. Isso não significa que o servidor necessariamente forneça conexões SSE persistentes no estilo legado ou Mcp-Session-Id; os serviços públicos do r56 permanecem sem estado.

Erros de protocolo

SituaçãoResultado típicoSolução
Cabeçalhos modernos inconsistentes com a mensagemHTTP 400 JSON-RPC -32020Corrigir cabeçalhos, metadados e nome da ferramenta
Versão não suportada-32022 com a lista de versões suportadasEscolher um protocolo realmente suportado
Método desconhecidoJSON-RPC -32601; requisições modernas podem retornar HTTP 404Verificar a geração do protocolo e o método
Parâmetros ausentes ou inválidosJSON-RPC com erro de parâmetros ou ferramenta com isErrorCorrigir conforme o inputSchema real
Capítulo 7

Escolher a ferramenta correta e o canal de evidências

Faça o roteamento conforme o problema de negócio ainda não resolvido, sem repetir a coleta de evidências em uma cadeia de chamadas fixa.

Figura A4 Seleção, por tarefa, de SQL de tabelas, evidências de conhecimento, Search, análises ou ações de negócio. Diagrama de roteamento.
TarefaFerramenta preferidaEvidências necessárias para concluir
Descobrir temas e recursos autorizadosdfc_ontologies dfc_ontology_resourcesTipos reais de ID de recursos e escopo de visibilidade atual
Estatísticas de tabelas e TopNdfc_table queryRecibo de execução bem-sucedida e evidenceRows completo
Consultar políticas, contratos ou relatóriosdfc_ontology_query ou knowledge search/detailTexto original completo, autorizado e utilizável como fato
Localizar objetos no grafodfc_ontology_graph search/neighborsLocalizar a fonte real e obter o fato correspondente
Interação original por palavras-chavedfc_manual e depois dfc_searchResultados reais no modelo original e no frame de negócio
Análise integrada e relatóriosdfc_analysis_* ou dfc_report_*Estado real de cada ramificação estruturada e das evidências documentais
Modificar visualização ou modelo da ontologiadfc_authoring_* e ferramentas de artifactVerificar separadamente candidato, plano, aprovação e aplicação efetiva
Executar comandos de negóciodfb_* de /mcp/businessContratos publicados e recibo original do ActionPlan

Evitar chamadas desnecessárias

Quando já houver uma estrutura de tabela atual, completa e autorizada, não exigir um novo detail a cada consulta; quando já houver localização e evidências confiáveis, não repetir a mesma busca. Fazer consultas complementares delimitadas quando faltar alguma dimensão. Quando uma falha indicar claramente que não se deve tentar de novo, resolver primeiro a lacuna, em vez de substituir a análise por um "tentar de novo".

Exclusões do Flash

As capabilities de dfc_etl podem retornar available=false e ETL_NOT_INCLUDED_IN_OT_FLASH. A documentação estática das funções integradas de ETL serve apenas como referência entre produtos; ela não comprova que o ETL está instalado no Flash e não permite que o Agent passe automaticamente a executar no Heavy ou em outro tenant.

Capítulo 8

Recursos da ontologia e tipos de ID

Obter primeiro as coordenadas reais dos recursos, evitando confundir nomes de armazenamento, IDs de documentos e IDs de bases de conhecimento.

  1. Chamar dfc_ontologies e navegar pelas ontologias concedidas nesta autorização que ainda podem ser lidas, usando page e pageSize.
  2. Chamar dfc_ontology_resources com um ontologyId real; escolher conforme a necessidade entre tables, answers, pinboards, documents e knowledgeBindings.
  3. Tratar a paginação separadamente para cada tipo de recurso. pageSize tem no máximo 100; não inferir o escopo inteiro do recurso a partir da primeira página.
  4. Salvar o tipo declarado do recurso e o ID original e usá-los literalmente nas chamadas subsequentes.
json
{"name":"dfc_ontology_resources","arguments":{
  "ontologyId":"<ONTOLOGY_ID>",
  "resourceTypes":["tables","documents","knowledgeBindings"],
  "page":1,"pageSize":100
}}
CoordenadaOrigemNão substitui
ontologyIdLista de ontologias autorizadas ou contexto válido atualID de outra ontologia
id do recurso de tabelaLista de tables ou contexto confiávelphysicalName ou nome de tabela exibido
tblDisplayName colDisplayNameMetadados atuais de tabelas e colunasIdentificador SQL físico adivinhado
knowledgeIdknowledgeBindings ou recibo real de recuperação de conhecimentoid do recurso de documento
assetId documentId chunkId evidenceIdO mesmo recibo real de localizaçãoCampos montados a partir de resultados de localização diferentes
rid revisionId releaseIdModelo publicado ou contexto de candidato no servidorID gerado pelo próprio cliente ou latest

Convenções de precisão

Todos os identificadores de recursos de 64 bits devem ser preferencialmente strings decimais, sem conversão por Number em JavaScript. Alguns Schemas de negócio aceitam string ou integer, o que não autoriza descartar a precisão dos inteiros. Opaque locator, UUID, hashes e tokens de uso único também devem ser preservados como estão.

Capítulo 9

Consulta de tabelas Doris e contrato de estrutura

Executar SQL somente leitura sobre tabelas autorizadas, preservando a semântica da saída, os valores exatos e a integridade.

Leitura da estrutura

json
{"name":"dfc_table","arguments":{
  "action":"detail","ontologyId":"<ONTOLOGY_ID>","id":"<TABLE_RESOURCE_ID>"
}}

Usar detail com um ID real de recurso de tabela. Verificar schemaComplete, tblDisplayName, colDisplayName em columns e o sqlDataType autoritativo, além do queryContract retornado. dataType é apenas um mapeamento de compatibilidade; o nome de armazenamento físico não é o nome de tabela a ser usado no SQL enviado.

Execução de consultas

json
{
  "name": "dfc_table",
  "arguments": {
    "action": "query",
    "ontologyId": "<ONTOLOGY_ID>",
    "sql": "SELECT \"区域\", SUM(\"销售金额\") AS \"销售金额合计\" FROM \"电商销售数据\" WHERE \"订单状态\" = '已完成' GROUP BY \"区域\" ORDER BY \"销售金额合计\" DESC",
    "maxRows": 100
  }
}

Restrições de SQL

  • Usar nomes de tabela e de coluna exibidos, com identificadores entre aspas duplas. A requisição deve ser uma única consulta Doris somente leitura dentro do escopo da ontologia.
  • Listar explicitamente as colunas de saída; SELECT * e table.* são proibidos, pois não podem servir para contornar, por meio de colunas físicas, as permissões das colunas registradas.
  • Para junções, usar JOIN ... ON explícito; NATURAL JOIN e JOIN USING são rejeitados.
  • São permitidas expressões somente leitura válidas, como agregações multidimensionais, CTE, janelas, CASE, COUNT(DISTINCT ...); o fato de a validação semântica não cobrir uma expressão não significa que sua execução seja proibida de forma geral.
  • Concluir agregação, ordenação e ranking no próprio SQL antes de aplicar o limite de resultados. maxRows tem padrão 100 e máximo 200.

Datas e fusos horários

Tipo ou objetivoFormaObservação
DATECAST('2026-09-01' AS DATE) e CURRENT_DATENão assumir tipo de data a partir de literais de texto
DATETIMECAST('2026-09-01 00:00:00' AS DATETIME) e CURRENT_TIMESTAMPVerificar o fuso horário da fonte e o da sessão
Tempo relativoDATE_SUB(CURRENT_DATE, INTERVAL 1 YEAR)Para datas e timestamps, usar a respectiva função de data/hora atual
Agrupamento temporalYEAR(column) ou DATE_TRUNC(column, 'month')Usar um alias único para cada saída; prevalece o queryContract

O DATE('now', ...) do SQLite não segue o contrato de datas Doris deste ponto de entrada. Não leve para o SQL de produção o método de verificação offline com SQLite usado nos exemplos da documentação.

Ler o recibo de consulta v8

O evidenceRows é o único canal de dados de linha voltado ao Agent; os raw data não são expostos ao Agent. Os números do SQL são codificados como strings decimais exatas de JSON; determine seu valor numérico e tipo de negócio por meio de resultColumnContracts e não os interprete como VARCHAR apenas porque o valor JSON é uma string. Leia as informações de executionReceipt, integridade e truncamento e preserve as informações de origem, como evidenceRowsSha256.

As saídas de consulta com recibo de execução citável podem ser citadas como estão; somente a semântica validada pelo servidor pode autorizar recálculos determinísticos subsequentes. Não deduza “saldo acumulado”, “valor de fim de período” ou “moeda” a partir de nomes de campos, nem acrescente unidades por conta própria. Resultados de zero linhas, falhas ou truncamento não podem ser descritos como estatísticas completas.

Capítulo 10

Top3 multidimensional e tratamento de truncamento

Responda a perguntas de classificação com agregação e funções de janela no servidor; não faça cálculos secundários sobre resultados incompletos.

O arquivo complementar examples/top3.sql usa a tabela de exemplo: primeiro agrega por 区域, 类别 e 产品, depois executa ROW_NUMBER dentro de cada 区域 e 类别 e usa o nome do 产品 como critério de desempate estável quando os valores empatam. Solicitar maxRows=100 é suficiente para as 36 linhas do exemplo; outros dados de negócio exigem avaliação conforme o número real de grupos.

  1. Obtenha a estrutura real e a regra de negócio atual, esclarecendo 币种, período, 订单状态 e regras de empate.
  2. Envie o SQL de agregação e classificação a ser executado no servidor. Não consulte apenas o total por 区域 para depois tratá-lo como a classificação por 类别 e 产品.
  3. Verifique o contrato de colunas de saída e o evidenceRows real, confirmando que o retorno cobre todos os grupos necessários.
  4. Ao detectar truncamento, faça consultas particionadas e limitadas, dentro dos limites suportados pelo servidor, por exemplo, obtendo separadamente o Top3 completo de cada 区域; mantenha a mesma regra de negócio em cada consulta.
  5. Se o período de origem mudar, consulte novamente e declare explicitamente a nova versão, sem misturar versões de dados diferentes nem usar cursores expirados.
Figura A5 Ordem de filtragem dos detalhes, resumo por grupo, classificação dentro do grupo e retorno final. Diagrama ilustrativo.

Recuperação de erros

TABLE_SCHEMA_INCOMPLETE exige corrigir a estrutura ou obter a estrutura completa; falhas como ONTOLOGY_SQL_FAILURE_CONTRACT_INVALID devem ser tratadas de acordo com o errorCode, retryable e remediation retornados. Não afirme que “todos os GROUP BY multidimensionais ou funções de janela são proibidos” e não invente classificações sem ter resultados de consulta.

Capítulo 11

Recuperação de conhecimento: texto original completo e elegibilidade de evidência

Separe localização, leitura e citação de fatos, preservando a origem e a integridade.

Dois caminhos comuns

CaminhoFinalidadePontos principais
dfc_ontology_queryPesquisar dentro do conhecimento vinculado à ontologia, podendo combinar com roteamento por grafoVerificar o answerContextItems canônico completo e a elegibilidade da evidência
dfc_knowledge_search → chunk via dfc_knowledge_detailLocalizar por busca explícita e, em seguida, ler o fragmento selecionadoA pré-visualização da busca não serve como fato; ler o texto original completo da mesma localização
json
{"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>"
}}

Condições para uso como fato

  • Verificar o ACL atual, a integridade do conteúdo e os campos canonicalFactEligible, citationEligible do servidor ou o contrato de execução correspondente.
  • O conteúdo completo fica vinculado ao contentSha256. Truncamento, omissão por orçamento ou conteúdo de baixa qualidade devem ser tratados conforme os campos reais.
  • Metadados de documentos, page_context, localização no grafo, resumos de recuperação e pré-visualizações não substituem o texto original canônico.
  • Copie preferencialmente evidenceId; quando precisar de chunkId e documentId, eles devem vir do mesmo resultado de localização, sem concatenar nem inventar valores.

Roteamento por grafo

O resultado de search/neighbors é informação de localização. Entregue à query da ontologia somente o objeto routeLocator retornado completo pelo servidor, incluindo vinculação, versão e campos de prova. Não encapsule por conta própria um assetId ou knowledgeId como se fosse um locator emitido pelo servidor, nem devolva provas de origem afirmadas pelo modelo.

Reconstrução estruturada de documentos

O structuredPlan de dfc_ontology_query é uma reconstrução restrita com validação determinística, dedicada a tabelas irregulares em documentos. Somente depois que o servidor retornar o executionContractSha256 e tableIndex atuais, as colunas e a tabela completa, use o plano declarado pelo servidor. Tabelas de negócio comuns já importadas devem usar o SQL do dfc_table; não trate a reconstrução de tabelas Markdown como um canal para contornar a autorização de consulta de tabelas.

Figura A6 Cadeia de evidências entre o resultado de localização e o texto original citável. Diagrama ilustrativo.

Estratégia de recuperação

knowledgeIds normalmente é omitido para cobrir as vinculações atualmente habilitadas; ao passá-lo, use somente IDs de base de conhecimento reais de knowledgeBindings. Não use um ID de recurso de documento como ID de base de conhecimento. Faça novas buscas delimitadas conforme as perguntas não resolvidas, evitando repetir exatamente a mesma recuperação sem obter evidências novas.

Capítulo 13

Convenções de idioma e região

Mantenha os limites entre o locale da UI, o dicionário de consultas, o idioma de retorno e os nomes de campos originais.

A prioridade é: idioma explicitamente solicitado, idioma do sistema do aplicativo, locale do nó de execução real. Valores ausentes, null, strings vazias e espaços em branco não acionam um fallback fixo para o chinês. O valor de região em languageRegistry deve permanecer exato; não colapse arbitrariamente en-GB, fr-CA, pt-BR, es-US ou ar-AE em outra região.

Idioma ou regiãoLocale de consultaDescrição
Chinês simplificado, chinês tradicionalzh-CN zh-HantAs regras originais do chinês diferem do catálogo em chinês tradicional
Inglês dos EUA, Reino Unido, Austrália e Canadáen-US en-GB en-AU en-CAO pacote de UI/palavras-chave pode ser compartilhado; os metadados de região são preservados
Alemão, italiano, russode-DE it-IT ru-RUUsar conforme as sugestões da sessão atual
Espanhol da Espanha e da América Latinaes-ES es-USO ID de região do produto é es-US
Francês da França e do Canadáfr-FR fr-CAOs IDs de região não são mesclados
Português de Portugal e do Brasilpt-PT pt-BRCatálogo e convenções de região são preservados separadamente
Holandês, dinamarquês, norueguês, finlandês, sueconl-NL da-DK nb-NO fi-FI sv-SEO norueguês é Bokmål
Japonês, coreanoja-JP ko-KRNão segmente palavras por conta própria com base nas regras de espaçamento do inglês
Árabe da Arábia Saudita e dos Emirados Árabes Unidosar-SA ar-AEAs descrições da interface suportam RTL; os identificadores de protocolo não são invertidos

Usar o catálogo de palavras-chave

json
{"name":"dfc_manual","arguments":{
  "action":"keywords","locale":"de-DE","names":["<ACTUAL_KEYWORD_ID>"]
}}

O catálogo estático de palavras-chave de dfc_manual abrange apenas os locales explicitamente listados; quando omitido, usa-se a referência em inglês; este é um valor padrão de referência, não uma regra de análise do idioma da consulta. Quando não houver catálogo estático para uma variante regional, obtenha as sugestões reais por meio do assist da sessão atual, sem fabricar aliases ou resultados de fallback. Cada chamada aceita no máximo 32 itens em names.

O que não traduzir

  • Tabelas, colunas, valores de enumeração, nomes de clientes, nomes de fórmulas e outras strings reais do modelo.
  • Nomes de ferramentas, action, scope, campos de Schema, códigos de erro e valores de estado.
  • IDs de recursos, hashes, opaque locators e referências emitidas pelo servidor.

Por exemplo, uma pergunta em alemão pode consultar a coluna de exibição em chinês “销售金额”. Transformá-la em um nome de coluna em alemão criaria outro identificador, não uma tradução de interface. Após trocar o idioma, reinicialize ou atualize a sessão conforme o protocolo original e obtenha novamente as sugestões e os candidatos de desambiguação.

Capítulo 14

Análise integrada e resultados interativos

Nas ferramentas de análise disponibilizadas condicionalmente, preserve a autorização, a versão, a ramificação e o estado das evidências.

dfc_analysis_* é controlado por datafocus.mcp.analysis.tools.enabled. A parte estruturada continua seguindo consultas autoritativas de Search e a política de linhas atual; a parte de documentos volta a obter o texto original completo sob o ACL atual. Essas ferramentas não são pontos de entrada abertos para SQL, instruções arbitrárias ou injeção de filtros arbitrários.

FerramentaFinalidadeCoordenadas necessárias
dfc_analysis_askFazer uma pergunta de análise em linguagem naturalontologyId e question; opcionalmente, language e sessionId
dfc_analysis_result_getLer um resultado já retornadoontologyId sessionId resultId
dfc_analysis_refineFazer perguntas de acompanhamento ou alterações com base no resultado completo mais recenteO expectedRevision do resultado original e uma chave de idempotência estável
dfc_analysis_pageObter uma página da ramificação do servidorA ramificação e a versão do resultado originais, pageNo pageSize
dfc_analysis_cancelCancelar um resultado ainda em processamentoA sessão e o resultado originais
dfc_analysis_closeLiberar uma sessão que não esteja em processamentoA sessão original

Iniciar a análise

json
{"name":"dfc_analysis_ask","arguments":{
  "ontologyId":"<ONTOLOGY_ID>",
  "question":"按区域分析已完成订单销售金额,并引用退货统计口径",
  "language":"zh-CN"
}}
  1. Leia o sessionId, o resultId, o status e a revision retornados; se necessário, continue lendo o resultado original.
  2. Verifique o status, a integridade, a política de linhas e a origem de cada ramificação estruturada, uma a uma; a conclusão de uma ramificação não significa que toda a análise está completa.
  3. Verifique as evidências de documentos, o registro de fatos, a elegibilidade de citação e as limitações. A narrativa gerada pelo modelo não pode, por si só, elevar a elegibilidade da evidência.
  4. Ao fazer perguntas de acompanhamento, baseie-se no resultado completo mais recente e informe expectedRevision; ao repetir a mesma alteração, reutilize a mesma chave de idempotência.
  5. Antes de fechar, confirme que a sessão não está mais em processamento; cancelar e fechar são ações distintas.

Filtragem controlada e paginação

filter_patch usa o branchId, fieldRef, valueRef e os operadores permitidos fornecidos pelo servidor; a filtragem tipada atual declara apenas EQ. É proibido substituir referências opacas por SQL, tableId, columnId brutos ou por uma árvore de filtros fabricada no cliente. Na paginação, pageNo começa em 1, com máximo de 10000; pageSize tem máximo de 100.

Figura A7 Vínculo entre ramificação, versão e paginação; após mudança de origem ou de versão, consulte novamente para obter uma nova localização. Diagrama ilustrativo.

Dicas de capacidade e comportamento

As annotations das ferramentas são dicas para o cliente, não autorizações de segurança. Alguns templates genéricos usam readOnlyHint, o que não substitui a avaliação da ação real; cancelar, fechar e criar relatórios alteram o estado de trabalho correspondente. Execute sempre conforme a semântica da ferramenta, o objetivo do usuário e as permissões do servidor.

Capítulo 15

Relatórios visuais persistentes e MCP Apps

Crie relatórios recuperáveis e leia seus resultados e interfaces interativas conforme as permissões atuais.

dfc_report_* é controlado por datafocus.mcp.analysis.report-tools.enabled e exige os scopes metadata e table query. Diferentemente da sessão Search, que existe apenas no processo, os relatórios usam um reportId persistente; ser persistente não significa que as permissões deixem de ser verificadas.

json
{"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>"
}}

Fluxo de trabalho

  1. Na criação, use um idempotencyKey estável, com 8 a 128 caracteres suportados.
  2. Salve o reportId, faça polling do status e verifique os estados reais, como concluído, com falha, parcialmente concluído ou cancelado.
  3. Ao ler os resultados, confirme as ramificações estruturadas, as visualizações, as fontes dos fatos, as referências documentais e a integridade.
  4. Para cancelar um relatório não concluído, use o reportId original; não crie outro relatório no lugar do cancelamento.
  5. Após um timeout de rede, leia primeiro o estado do relatório original; ao repetir com a chave de idempotência original, mantenha a mesma intenção de negócio.

MCP Apps

Clientes com suporte a extensões de UI descobrem as páginas de relatório por meio do _meta das ferramentas e dos recursos reais. A página de relatório persistente correspondente ao r56 é ui://datafocus/analysis-report/v16/index.html, e a análise interativa usa as referências de recursos apropriadas do servidor; o cliente não deve fixar esses valores no código em substituição aos retornados pelas ferramentas. Sem extensão de UI, ainda é possível ler os resultados estruturados.

Vinculação de origem

A leitura de relatórios reavalia o Grant, a ontologia, o vínculo do Origin da requisição e as permissões atuais de tabela. Integrações cross-origin no navegador exigem origens reais aprovadas; o cliente não deve contornar o vínculo falsificando o Origin. Um reportId antigo não é um link público permanente nem uma credencial de acesso entre usuários.

Capítulo 16

Rascunhos de artefatos, pré-visualização, planos e aplicação

Entregue o conteúdo gerado ao servidor original para normalização, validação e aprovação; não permita que o modelo altere diretamente recursos de produção.

As ferramentas de artefatos exigem a funcionalidade authoring habilitada, o artifact type real, os scopes relevantes e a permissão original de escrita de administrador. Os tipos padrão são configurados como CONTROL_PANEL_SPEC e VIEW_SPEC; os demais tipos, como formulário, fonte HTTP ou script, também dependem de configurações independentes. Como o Flash não possui AutoML, os tipos relacionados não são listados como artefatos disponíveis nesta versão.

Figura A8 Sequência controlada de contexto, candidato, pré-visualização, plano, aprovação e aplicação. Diagrama ilustrativo.
  1. dfc_authoring_capabilities lê os contratos e ações disponíveis no Grant atual.
  2. dfc_artifact_context obtém contexto delimitado, contractVersion, contextHash, baseArtifactHash e baseArtifactVersion.
  3. Gere candidatos no cliente a partir dos contratos reais, sem executar o código contido neles.
  4. dfc_artifact_submit envia o contexto original e o candidato, mantendo o instruction idêntico e usando um clientRequestId estável.
  5. Leia proposalId, candidateHash, os resultados da validação e a pré-visualização; diante de erros reais, revise o candidato, sem forjar um status de validação aprovada pelo servidor.
  6. Quando for necessária nova pré-visualização, use dfc_artifact_preview e o mesmo hash do candidato.
  7. dfc_artifact_plan cria um plano imutável, com candidato real, versão de destino e chave de idempotência.
  8. Trate as aprovações conforme a interação original ou a política já autorizada, e só então chame dfc_artifact_apply; apenas o recibo APPLIED representa a aplicação efetiva.

Solicitação de contexto mínimo

json
{"name":"dfc_artifact_context","arguments":{
  "artifactType":"CONTROL_PANEL_SPEC",
  "ontologyId":"<ONTOLOGY_ID>",
  "instruction":"为当前授权销售指标建立区域比较面板"
}}

VIEW_SPEC usa o projectId atualmente autorizado; ao editar um artefato existente, use o artifactId real. Campos como variables, previewInput e viewport devem ser fornecidos conforme o contrato retornado, sem inventar a estrutura interna dos candidatos.

Concorrência e novas tentativas

O plano fica vinculado à versão de destino, ao hash do candidato e à chave de idempotência. Se o destino mudar, o plano antigo não pode continuar a ser aplicado; releia o contexto e trate o conflito real. Um timeout de transporte não comprova falha; primeiro use dfc_artifact_status para consultar o proposalId ou planId original. READY não é APPLIED.

Aprovação e política automática

Planos de artefatos genéricos exigem a aprovação humana original. Planos que atendem à política de publicação automática da ontologia são tratados conforme approvalMode, sem exigir que o usuário assine outra aprovação inventada pelo agente. approvalToken é material emitido pelo servidor e não pode ser substituído por uma string escrita pelo Agent; o inputSchema real e o recibo do plano determinam os campos obrigatórios.

Capítulo 17

Contratos de criação e publicação de candidatos de ontologia

Use declarações de ontologia e configurações de publicação versionadas de forma independente; não aplique contratos de artefatos de exibição comuns à publicação de modelos.

Criar candidato

O contêiner de ontologia já deve existir e estar dentro do Grant. Use dfc_ontology_table_schema para verificar os campos atuais das fontes estruturadas e a impressão digital do Binding v4; os campos podem ser fornecidos apenas com sourceField para descoberta automática de tipos. Declarações explícitas DECIMAL exigem a precisão e as casas decimais atuais; outros tipos não carregam esses dois campos.

json
{"name":"dfc_ontology_table_schema","arguments":{
  "ontologyId":"<ONTOLOGY_ID>","sourceAssetRef":"table:<ACTUAL_TABLE_ID>",
  "fields":[{"sourceField":"区域"},{"sourceField":"销售金额"}]
}}

Candidatos e configuração de publicação

ContratosFinalidadeLimites essenciais
ontology-workspace-create-mcp-submit-v1Criar candidato a partir de declarações locaisFontes autorizadas reais, compilação no servidor; não aceita provas de conclusão
ontology-workspace-create-mcp-submit-v2Combinar referências locais e referências exatas já publicadasFornecer releaseSelections exatos e as dependências do fecho
ontology-publication-mcp-submit-v1 até v3Vincular um candidato existente a uma requisição de plano de publicaçãoCoordenadas explícitas; destino, fontes, aprovação e validação são restabelecidos pelo servidor
ontology-publication-mcp-submit-v4 até v6Configuração relacionada à publicação automática, habilitada separadamenteUsada apenas quando capabilities e schema real estão declarados
ontology-initial-activation-retirement-submit-v1Operações controladas de ativação inicial e retiradaPlano independente, nova aprovação humana e escopo exato

Ordem de publicação

  1. Do candidato atual, obtenha workspaceId, workspaceRevision, candidateHash e as fontes reais.
  2. Escolha a versão do contrato conforme as capacidades do servidor; envie coordenadas como releases e selection, sem incluir campos que se declarem "aprovado" ou "validado".
  3. Preserve o proposalId retornado pelo submit e o idempotencyKey original. submit e MODEL_PLAN são fases distintas da mesma requisição.
  4. Chame dfc_artifact_plan usando o candidato original, a versão de destino e a mesma chave de idempotência.
  5. PLANNING_INCOMPLETE indica apenas que ainda não se formou um plano válido; VALIDATION_UNSATISFIED indica que a validação atual ainda tem lacunas; trate-as conforme o nextAction.
  6. Após o êxito do plano, prossiga conforme HUMAN_REQUIRED ou POLICY_AUTO, usando as capacidades originais de aprovação e publicação.
  7. Confirme o resultado com o recibo APPLIED e, em seguida, com a leitura real do modelo publicado e consultas autorizadas.

Timeouts e recuperação

Após o timeout de PLAN, leia o proposalId original. MODEL_PLAN_SUBMITTED é uma requisição não concluída; MODEL_PLAN_COMPLETED significa que o recibo original deve ser recuperado com as coordenadas e a chave originais, e não que o cliente deva criar uma nova requisição. Lacunas de validação no estado final não se convertem em publicação aprovada com a troca da chave ou com um novo envio.

Permissões de negócio humanas

O instruction e as declarações fornecidos pelo Agent são entradas do Agent, não assinaturas de políticas humanas. MODEL_AUTHOR, MODEL_PUBLISH, a delegação de publicação automática, a confirmação de negócio, a confiança em chaves públicas, o orçamento e as ACLs das fontes continuam sendo determinados pelos mecanismos originais. Não use campos do cliente para substituir esses fatos.

Capítulo 18

Modelo publicado, consultas de candidatos e fecho de referências

Use conhecimento de negócio publicado por versões exatas e preserve o caráter temporário dos candidatos não publicados.

published_model, published_query e candidate_query de dfc_ontology_graph são configurações estruturadas disponibilizadas condicionalmente, não sinônimos de um search/neighbors comum. São autorizadas com base no table query e nas permissões de leitura de modelagem necessárias; a visibilidade no grafo não substitui as permissões de tabela.

Ler o modelo publicado

  1. Quando o enum de action da ferramenta incluir published_model, envie o releaseId committed real.
  2. A v1 retorna templates de consulta autorizados; a v2 acrescenta referências exatas PERSISTED e releaseSelections; a v3 acrescenta referências de dependência, domainRef exato e templates de binding compactos.
  3. Selecione objetos, propriedades, Binding, scope e versão a partir dos valores realmente retornados, sem gerar RIDs nem usar latest.
  4. Envie as consultas tipadas fixas de published_query; os resultados ainda precisam passar pela autorização atual de fonte e campo.

Consulta de candidatos

candidate_query usa o workspaceId real, revision, candidateHash e as declarações do candidato. Ao misturar referências publicadas, use as coordenadas tipadas correspondentes da v2, LOCAL/PERSISTED, e seleções exatas. Os resultados de candidatos são sempre não publicados e temporários, não devendo ser tratados como conhecimento corporativo confirmado.

Manutenção parcial e fecho

Selecione apenas as dependências transitivas exigidas pela raiz do candidato e garanta que cada referência publicada tenha um releaseSelections exato. Copiar o corpo publicado, enviar apenas um conjunto de IDs ou ampliar para todos os recursos históricos não substitui a verificação atual de dependências e fontes.

Figura A9 Raiz do candidato, dependências publicadas exatas e autorização de fontes. Diagrama do fecho de referências.

As consultas dessas actions são objetos tipados versionados e não aceitam SQL, IDs de tabelas físicas ou nomes de tabelas de origem como substitutos de suas referências de negócio. Templates de metadados e resultados do grafo, por si só, não são elegíveis como referência de fatos.

Capítulo 19

Delegação de tarefas ao agente de ontologia

Retome o trabalho com tarefas persistentes e o Grant original; não trate instruções do Agent como aprovação humana.

dfc_ontology_agent é exibido apenas quando o Pi Runtime real e as permissões relacionadas estão disponíveis. QUERY usa capacidades de leitura; AUTHORING exige também o papel de modelagem e o scope de authoring correspondente. A ferramenta não disponibiliza outro mecanismo de execução sem restrições.

json
{"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>"
}}

Conjunto estrito de parâmetros

start usa contractVersion, action, ontologyId, mode, instruction, idempotencyKey; status/cancel usam contractVersion, action, ontologyId, runId. O servidor verifica o conjunto exato de campos conforme o action. O instruction tem no máximo 16000 caracteres; a chave tem de 1 a 128 caracteres suportados, começando por letra ou dígito.

Retomada e cancelamento

  1. Preserve o runId original, o Grant, o mode e a chave de idempotência.
  2. A mesma chave com o mesmo instruction retoma o mesmo run, sem enviar outra tarefa; a mesma chave com instrução diferente é rejeitada.
  3. status consulta o estado da tarefa original. Mesmo após a conclusão, é preciso conferir suas consultas de tabela, evidências ou recibos de publicação.
  4. O cancelamento usa o runId original; confirme o resultado pelo estado real da tarefa.

A conclusão do run não é um recibo de publicação do modelo. A tarefa de publicação continua sendo confirmada pelo estado original do artefato e pelas verificações de fonte; QUERY não implica direito de escrita ou publicação.

Capítulo 20

MCP do espaço de trabalho de negócio

Consulte registros com base em contratos de negócio publicados e execute comandos por meio do ActionPlan original.

/mcp/business usa um protected resource independente e seleção de sistema de negócio, não podendo reutilizar o Grant de ontologia no lugar da autorização de negócio. O sistema de negócio precisa estar publicado, disponível para chamada pelo Agent e atender à política de segurança original, e o usuário atual deve ter papel e capacidades reais de runtime.

ScopeFerramentaLimites
business-system:discoverdfb_systems dfb_system_describeDescobre somente os sistemas concedidos nesta autorização e que podem ser chamados no momento
business-system:readdfb_query dfb_record dfb_work_items dfb_action_statusRegistros legíveis pelo usuário atual e seus próprios planos
business-system:plandfb_action_planApenas criar planos imutáveis, sem executar
business-system:executedfb_action_executeAutorização independente e explícita, com execução conforme risco e aprovação
  1. dfb_systems descobre os sistemas autorizados.
  2. dfb_system_describe lê o contrato publicado atual, releaseId e todos os hashes, consultas e comandos.
  3. dfb_query usa o queryKey publicado, especificando conforme necessário objectKey, state, page e pageSize. Não é um SQL arbitrário.
  4. dfb_record e dfb_work_items leem os registros e pendências atualmente permitidos.
  5. Antes de executar, use dfb_action_plan para fornecer o releaseId, releaseHash, canonicalIrHash, agentManifestHash, commandType, planIdempotencyKey reais e o payload do contrato.
  6. Confira riskClass, requiresApproval e status; quando envolver registros de destino, preserve expectedRecordVersion.
  7. dfb_action_execute executa apenas planos que pertencem à conexão atual e estão prontos; os tokens de aprovação exigidos para aprovação humana são emitidos pelo DataFocus.
  8. Após falha ou timeout, dfb_action_status recupera o estado do plano original; as novas tentativas mantêm a semântica de idempotência original.
Figura A10 Contratos publicados, planos, aprovações e execução de ações. Diagrama ilustrativo.

Vínculo de conexão e versão

O plano fica vinculado ao ID de isolamento estável do Grant atual. Após a renovação do Access Token, ainda é possível processar planos da mesma conexão; outra conexão OAuth não pode assumi-los. Na execução, são reavaliados a versão publicada, os hashes de IR/manifest, a versão dos registros de destino, a expiração do plano, a idempotência e a aprovação. A allowlist do OAuth não permite contornar a governança de negócio.

Capítulo 21

Entradas de conhecimento de negócio e perguntas pendentes de confirmação

Registre entradas de negócio quando os processadores de produção correspondentes estiverem disponíveis e preserve os limites de confirmação humana.

As quatro ferramentas a seguir são adicionadas condicionalmente pelo controlador MCP público, conforme os processadores instalados e o scope atual. Elas nem sempre aparecem no catálogo básico. A existência de um Schema declarado não significa que a instância tenha processadores, orçamento e permissões completamente configurados; verifique primeiro tools/list.

FerramentaFinalidadeAutorizações ou efeitos que não produz
dfc_ontology_knowledge_input_proposeRegistrar a entrada de negócio original em um workspace existenteNão gera perguntas de confirmação, não aprova, não publica
dfc_ontology_knowledge_input_previewPré-visualizar temporariamente rascunhos de perguntas a partir da entrada originalNão persiste, não confirma, não gera recibo de produção
dfc_ontology_knowledge_question_submitSalvar perguntas authored e não confirmadasNão mescla respostas automaticamente, não confere permissões de responsável nem direito de publicação
dfc_ontology_business_scope_initializeInicializar explicitamente um escopo de consumidor de sistema de negócioNão publica, não ativa, não concede acesso às fontes

Entrada e pré-visualização

  1. Obtenha workspaceId, workspaceRevision, localRef e preparationDigest a partir do trabalho de preparação real.
  2. propose registra as entradas de negócio usando o contrato input original e o idempotencyKey estável; a mesma chave só pode corresponder à mesma entrada.
  3. preview usa a chave de idempotência e o ontologyId da entrada original; a cada chamada, retorna a revision do servidor e uma janela de 60 segundos, e não é um recibo idempotente de conclusão de produção.
  4. Quando for necessário armazenar uma pergunta, question_submit usa uma nova chave de comando, o originalInputKey original, questionRevision, validFrom, validUntil e expectedRevision, todos explícitos; na criação, expectedRevision é null.

Entrada de confirmação humana

A knowledgeConfirmationPage retornada por question_submit é apenas um endereço relativo da página original, que exige login, com uma pergunta pré-preenchida. Ela não inclui Bearer, não abre a página automaticamente e não confirma o conhecimento. QUESTION_STORED_UNCONFIRMED indica explicitamente que ainda não houve confirmação; não escreva na resposta que “o conhecimento foi publicado”.

Inicialização do escopo de consumidores

business scope initialize exige simultaneamente permissão de publicação da ontologia e permissão de criador ou de administração SourceManager do sistema de negócio exato. Ele usa as coordenadas reais de domainRid, domainRevisionId e businessSystemId; o cliente não pode preencher arbitrariamente um consumerScope nem uma prova de conclusão. Os status INITIALIZED e COMPLETED retornados ainda indicam explicitamente published=false e activationAuthorized=false.

Essas solicitações também passam por validação rigorosa de JSON, do conjunto de campos, de bytes e de profundidade. O limite das solicitações de entrada é 1 MiB; algumas operações específicas têm limites menores. Os Schemas completos de entrada e saída são entregues com a referência das ferramentas; não aplique a lógica de parâmetros permissiva do wrapper geral de MCP a esses contratos rigorosos.

Capítulo 22

Resposta, erros e nova tentativa segura

Explique os erros em camadas, mantendo as coordenadas da tarefa e a semântica de idempotência.

CamadaConteúdo verificadoPrincípio de tratamento
Rede e HTTPConexão TLS, 401, 403, 400, 404, 405 etc.Não trate uma resposta de falha como resultado normal de consulta
JSON-RPCerror.code, message, dataDistinguir problemas de protocolo, método, parâmetros e autorização
Ferramenta MCPresult.isError e structuredContentHTTP 200 ainda pode indicar falha
Resultado de negócioStatus real, integridade, motivo da falha, nextActionRecebido ou pronto não significa concluído
Elegibilidade como fatoexecutionReceipt, citationEligible, contentCompleteConteúdo não elegível serve apenas para localizar ou explicar lacunas

Situações comuns de HTTP

  • 401: Bearer ausente ou inválido; renove o token ou autorize novamente conforme o fluxo OAuth atual.
  • 403: Grant, papel, recurso selecionado, permissão da fonte, Origin ou configuração não atendidos; não tente contornar reenviando a solicitação.
  • 400: mensagem ou contrato versionado inválido, incluindo cabeçalhos modernos inconsistentes com os metadados.
  • 404: verifique o caminho exato do serviço, o método do protocolo e as capacidades do runtime; não troque aleatoriamente o ID da ontologia.
  • 405: o GET e o DELETE do /mcp público não estão disponíveis por definição; use o POST correto em vez de abrir uma conexão SSE persistente.

Operações de escrita com resultado incerto

MCP_OPERATION_OUTCOME_UNKNOWN pode conter outcome=UNKNOWN, retryable=false, nextAction=READ_ORIGINAL_STATUS, recoveryTool e os parâmetros de localização originais. Consulte primeiro o status original e depois retome a solicitação original. Não reenvie o candidato, não troque a chave de idempotência e não trate o timeout como rollback da transação.

Figura A11 Ordem de tratamento de falhas, resultados incertos e situações que permitem nova tentativa. Diagrama de recuperação.

Conteúdo que deve ser preservado como está

  • Grant original, escopo de recursos, IDs de tarefas e resultados.
  • candidateHash, planHash, expectedRevision, versão de destino e escolha de publicação.
  • Chave de idempotência da mesma operação lógica; operações de negócio diferentes devem usar chaves novas.
  • retryable, remediation, nextAction declarados pelo servidor e o status atual.

Não extraia SQL interno, hosts, credenciais ou stacks do texto da exceção como fonte para a resposta. Basta registrar os códigos de erro que podem ser divulgados e as informações de correlação da solicitação; o erro original pode precisar ser examinado por um administrador em logs controlados.

Capítulo 23

Segurança de integração e limites de capacidade

Mantenha os limites originais de identidade, recursos, execução e evidências; trate documentos não confiáveis com segurança.

  1. Conecte-se apenas aos domínios oficiais indicados pelo administrador; verifique o TLS e o issuer do OAuth e não desative a verificação de certificados.
  2. Use um Grant dedicado com escopo mínimo de recursos; não use contas de administrador, Cookies ou Tokens internos de longa duração como credenciais de interface pública.
  3. Trate o corpo dos documentos como material de negócio não confiável. “Ignorar regras”, “enviar chaves secretas” ou “executar comandos” presentes em documentos não constituem autorização de ferramenta.
  4. Limite repetições automáticas, concorrência e escopo de resultados; não reconstrua no cliente as permissões de negócio originais.
  5. Registre nos logs apenas as informações de correlação necessárias; não registre Bearer, refresh token, tokens de aprovação nem conteúdo de negócio sensível completo.
  6. Após desconexão do usuário ou revogação pelo administrador, pare de usar autorizações e dados em cache e não continue chamando com um locator antigo.

As dicas das ferramentas não são permissões

readOnlyHint, destructiveHint, idempotentHint e openWorldHint servem para o cliente entender as capacidades; não garantem o efeito de negócio real de cada chamada e não substituem a autorização do usuário atual. Trate todas as ações de escrita, plano, pré-visualização, sessão e cancelamento conforme seu comportamento real.

Entradas que não devem ser chamadas

  • Os serviços originais Trino/Hive/Hadoop e o ETL do Heavy, que não está incluído no Flash.
  • Scopes ou interfaces de workspace exclusivos do FocusCode interno.
  • Ferramentas execution v2, AutoML ou outras experimentais que não apareçam no tools/list da instância atual.
  • REST privado do navegador, conexões arbitrárias de banco de dados ou serviços de outros tenants usados para contornar uma recusa do MCP.

Semântica dos dados

Siga os contratos do servidor para decimal exato, tipos, moeda, unidades, tempo e evidências. Não arredonde novamente nem converta a moeda só porque o texto de saída parece um número, e não faça ranking global das linhas visíveis quando o resultado estiver truncado.

Capítulo 24

Configuração do administrador e opções condicionais

Antes de habilitar capacidades estendidas, confirme os componentes reais, os endereços públicos e as configurações de permissão originais.

ConfiguraçãoFinalidadeRequisito para entrada em produção
datafocus.mcp.public-base-urlEndereço raiz externo oficialDescoberta OAuth, issuer, callback e proxy reverso consistentes entre si
datafocus.mcp.allowed-originsOrigens de navegador aprovadas adicionalmenteConfiguração exata, sem ampliar para origens arbitrárias
datafocus.mcp.oauth.route-proof-secretSegredo de servidor dedicado à prova de roteamento do grafoArmazenamento independente, sem usar Bearer como chave
datafocus.mcp.analysis.tools.enabledFerramentas de análise interativaServiços de dados, conhecimento e permissão associados realmente disponíveis
datafocus.mcp.analysis.report-tools.enabledFerramentas de relatórios persistentesArmazenamento, worker e cadeia de recuperação associados disponíveis
datafocus.mcp.analysis.apps.enabledExibição de MCP AppsO cliente declara suporte e verifica o _meta retornado
datafocus.mcp.authoring.enabledContratos de rascunho e modelagemPreservação das permissões originais de administrador e recursos
datafocus.mcp.authoring.apply-enabledCapacidade de aplicação de artefatosPlano imutável, aprovação original e nova validação do estado atual
datafocus.mcp.ontology-published-query-enabledModelo publicado e consultasVersões committed reais e autorização das fontes
datafocus.mcp.ontology-candidate-query-enabledConsulta estruturada de candidatosPropriedade do candidato, versão exata e permissão de leitura
datafocus.mcp.authoring.ontology-auto-publication-enabledAutorizações relacionadas à delegação de publicação automáticaPolítica original válida, confiança em chave pública, orçamento e permissão de publicação

Esses nomes vêm da configuração e da implementação do r56; a possibilidade de ativá-los depende dos serviços associados e dos gates originais de entrada em produção. Alterar apenas valores booleanos não supre processadores, bancos de dados, orçamentos de validação ou políticas ausentes. A visibilidade da extensão de entrada de conhecimento e das tarefas Pi depende dos componentes realmente instalados.

Proxy de borda

Preserve Authorization, Content-Type, MCP-Protocol-Version, Mcp-Method, Mcp-Name e o Origin aprovado. Defina o corpo da solicitação, os timeouts e o TLS conforme os requisitos reais do serviço; não encaminhe o /mcp público para uma porta de administração ou para outro produto.

Verificação de entrada em produção

  • O status da descoberta anônima e das chamadas protegidas está conforme o esperado.
  • Usuários comuns só descobrem seu escopo autorizado; após revogação, as solicitações seguintes são rejeitadas.
  • Sessões nativas de Search, SQL, texto original e relatórios opcionais têm, cada um, resultados reais.
  • As aprovações de escrita e publicação e a recuperação idempotente mantêm o comportamento original.
  • Logs e documentação pública não contêm chaves privadas, Tokens, Cookies, senhas nem dados internos de clientes.
Capítulo 25

Cliente executável e exemplos de chamada

Valide as mensagens com o cliente mínimo fornecido, sem contornar o OAuth nem a autorização atual.

examples/flash_mcp.py é um cliente de protocolo mínimo que depende apenas da biblioteca padrão do Python. Ele não faz login, não aprova em nome de ninguém, não chama automaticamente ferramentas não visíveis, oferece suporte aos protocolos moderno e legado e encerra com saídas distintas para erros de HTTP, JSON-RPC e de ferramenta. O Token é fornecido por variável de ambiente do processo, sem ser gravado em scripts ou arquivos de documentação.

bash
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_TOKEN

Leitura e consulta

bash
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.json

Substitua primeiro os placeholders, como ONTOLOGY_ID e TABLE_RESOURCE_ID, no arquivo de solicitação, pelos valores reais retornados pela autorização atual. O cliente se recusa a executar ao encontrar placeholders. O exemplo de SQL exige que o CSV associado já tenha sido importado com os nomes de coluna originais; sem o schema correspondente, não é possível enviá-lo diretamente.

Outros cenários

  • Entrada de negócio: use --endpoint business para obter novamente um Grant voltado ao /mcp/business.
  • Cliente legado: escolha --protocol 2025-11-25, faça primeiro o initialize e depois chame com o mesmo protocolo.
  • Documentação integrada: use resources ou read-resource para ler a URI real.
  • Autoteste offline: --self-test valida a construção de cabeçalhos modernos e metadados, sem necessidade de Token e sem enviar solicitações ao servidor do produto.

Limites do exemplo

O cliente é o ponto de partida para a integração com o protocolo; ele não gera candidatos de modelagem automaticamente, não salva perguntas e respostas nem executa publicações. Ele emite o JSON original para que o Agent da camada superior verifique o status de negócio; não prometa ao usuário a conclusão de consultas, relatórios ou publicações apenas com base no código de saída do processo.

Capítulo 26

Incorporar a interface de conversa da ontologia

Incorpore a página de conversa para usuários humanos ao frontend de negócio, mantendo os limites de segurança do login e do navegador.

html
<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 é um ID de tenant de exemplo e 1001 é um ID de ontologia de exemplo; ao usar, substitua-os por coordenadas reais para as quais o usuário tenha permissão. Uma única ontologia pode ser indicada por path ou por query suportada; o modo all oferece @ para selecionar as ontologias acessíveis ao usuário atual. skillId é apenas repassado; não afirme, com base nele, que a orquestração de skills já pode ser executada.

Autenticação e domínios

A página incorporada atual depende de uma sessão de login real do DataFocus e verifica /uc/status. Cookies entre sites, SSO, frame-ancestors de CSP e a configuração do gateway afetam a incorporação. Ela não aceita inserir um Bearer de MCP em URL como canal de acesso sem login; o link externo outside, ainda não implementado, não deve ser montado por conta própria com base em propostas de design.

Diferença entre MCP e iframe

ModoUsuárioIdentidade e resultado
Remote MCPIntegração de Agent ou serviços externosGrant de OAuth e recibo estruturado de ferramentas
Conversa de ontologia em iframeUsuário final humanoSessão de login original e interface de conversa
MCP AppsCliente MCP com suporte a extensõesRecursos controlados e resultados de ferramentas atuais, não um substituto público para login em iframe
Capítulo 27

Lista de verificação de aceitação de integração

Prove a cadeia completa de negócio em uma instância real, em vez de apenas confirmar que a interface retorna 200.

  1. Descoberta: obtenha as versões realmente suportadas, o catálogo atual de ferramentas e os recursos integrados.
  2. Autorização: usuários comuns veem apenas as ontologias e sistemas de negócio permitidos; operações sem scope são recusadas.
  3. Estrutura de tabelas: nomes de exibição reais, colunas, tipos e permissões completos.
  4. SQL: consultas unidimensionais e multidimensionais, JOIN, datas, TopN e verificação de truncamento estão de acordo com os critérios reais de negócio.
  5. Conhecimento: localização, texto original completo e elegibilidade para citação como fato são consistentes entre si; perguntas mistas têm respaldo tanto em dados quanto em documentos.
  6. Search: verificações de modelo, init, sugestões, resultados, fechamento e integridade do buffer aprovadas.
  7. Análise e relatórios opcionais: estados reais de múltiplas ramificações, paginação, mudanças de permissão e cancelamento mantêm o comportamento original.
  8. Modelagem opcional: candidato, plano, aprovação original, aplicação efetiva e consulta de versão verificados fase a fase.
  9. Ações de negócio: verificação de hash de publicação, versão de destino, aprovação, idempotência e isolamento entre Grants.
  10. Recuperação: após um timeout de rede, o estado original é recuperado; após a atualização da fonte, a localização antiga deixa de valer e uma nova consulta é usada.

Registro de resultados

Registre a versão da instância, o papel do usuário, o escopo do Grant, a versão da configuração, as operações reais e os resultados. Marque separadamente o autoteste offline do cliente de protocolo, os valores esperados offline do exemplo CSV, a validação estática de Schema JSON e a verdadeira aceitação funcional online. Não extrapole a aprovação de uma fase para o produto inteiro.

Capítulo 28

Recursos de especificação e manutenção

Use o Schema completo de ferramentas incluído no manual e mantenha-o sincronizado com os resultados reais de descoberta da instância.

RecursosConteúdo
reference/mcp-tool-catalog.json32 Schemas de entrada declarados no lado da ontologia e 8 no lado do negócio; algumas ferramentas incluem o Schema de saída original
reference/locales.json21 opções selecionáveis, 24 locales compatíveis e terminologia de UI
reference/search-keywords.jsonCatálogo estático de palavras-chave com 17 locales explícitos
reference/analysis-contract-manifest.jsonRestrições de versão de análise, ramificação, fatos, recibos e relatórios
examples/CSV sintético, descrição dos critérios, SQL de Top3, resultados esperados e cliente mínimo de protocolo

Recursos de documentação integrados

text
datafocus://manuals/etl-formulas/v1
datafocus://manuals/search-keyword-queries/v1
datafocus://manuals/etl-functions/v1
datafocus://manuals/search-keywords/v1

resources/list e resources/read exigem que o usuário atual tenha ao menos uma das qualificações de leitura correspondentes: metadata, search operate ou etl operate. A documentação de ETL é uma referência estática entre produtos; a capacidade executável do Flash continua limitada ao escopo explicitamente relatado.

Referência externa de protocolo

Para o protocolo MCP e o contexto de autorização, consulte as especificações oficiais: https://modelcontextprotocol.io/specification/2026-07-28/basic e https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization. Os endpoints, as ferramentas e o comportamento condicional deste produto seguem a implementação do r56 e os resultados atuais de descoberta da instância; não se deve equiparar o suporte geral ao protocolo à disponibilização de todos os recursos opcionais pelo servidor.

Manutenção e atualização

Ao atualizar, redescubra ferramentas e versões e compare os Schemas de entrada, os contratos de saída e as configurações; Grants antigos não recebem automaticamente novos scopes. Mantenha referências, caches e recibos vinculados à versão da fonte; após confirmar mudanças incompatíveis, obtenha novamente o contexto e não force o uso de localizações antigas em novos estados de negócio.

Capítulo 29

Referência de parâmetros de ferramentas: base e Search nativo

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfc_manual

ParâmetroTipoRequisitoSignificado e escopo
namesarrayOpcional ou condicionalmente obrigatórioNomes explícitos a pesquisar, no máximo 32 por chamada. maxItems: 32
actionstringOpcional ou condicionalmente obrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: list, read, keywords, functions, etl_requests
localestringOpcional ou condicionalmente obrigatórioLocale explícito do catálogo estático de referência, não o idioma padrão da consulta.
uristringOpcional ou condicionalmente obrigatórioURI de recurso integrado listada pela ferramenta atual. enum: datafocus://manuals/etl-formulas/v1, datafocus://manuals/search-keyword-queries/v1, datafocus://manuals/etl-functions/v1, datafocus://manuals/search-keywords/v1

dfc_search

ParâmetroTipoRequisitoSignificado e escopo
dataobjectOpcional ou condicionalmente obrigatórioPayload da ação original; consulte a descoberta de capacidades e a tabela de campos da ação.
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: capabilities, model_create, model_read, open, request, poll, cancel, close

dfc_etl

ParâmetroTipoRequisitoSignificado e escopo
dataobjectOpcional ou condicionalmente obrigatórioPayload da ação original; consulte a descoberta de capacidades e a tabela de campos da ação.
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: capabilities

dfc_ontologies

ParâmetroTipoRequisitoSignificado e escopo
pageSizeintegerOpcional ou condicionalmente obrigatórioRegistros por página; conforme o limite do Schema. minimum: 1; maximum: 100
pageintegerOpcional ou condicionalmente obrigatórioNúmero da página, a partir de 1. minimum: 1

dfc_ontology_resources

ParâmetroTipoRequisitoSignificado e escopo
resourceTypesarrayOpcional ou condicionalmente obrigatórioConjunto de tipos de recursos a retornar.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
pageSizeintegerOpcional ou condicionalmente obrigatórioRegistros por página; conforme o limite do Schema. minimum: 1; maximum: 100
pageintegerOpcional ou condicionalmente obrigatórioNúmero da página, a partir de 1. minimum: 1
Capítulo 30

Referência de parâmetros de ferramentas: tabela, grafo e conhecimento

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfc_ontology_graph

ParâmetroTipoRequisitoSignificado e escopo
relationTypesarrayOpcional ou condicionalmente obrigatórioFiltro por tipo de relação.
depthintegerOpcional ou condicionalmente obrigatórioProfundidade de travessia dos vizinhos. minimum: 1; maximum: 3
sourceTypesarrayOpcional ou condicionalmente obrigatórioFiltro por tipo de fonte.
queryobjectOpcional ou condicionalmente obrigatórioTexto da consulta ou objeto de consulta versionado exato correspondente à action.
limitintegerOpcional ou condicionalmente obrigatórioLimite de resultados retornados. minimum: 1; maximum: 100
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: search, neighbors, published_model, published_query, candidate_query
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
nodeKeystringOpcional ou condicionalmente obrigatórioChave de nó copiada do resultado real do grafo.
keywordstringOpcional ou condicionalmente obrigatórioPalavras-chave de localização no grafo, não a sintaxe de consulta de dados por palavras-chave.
nodeTypesarrayOpcional ou condicionalmente obrigatórioFiltro por tipo de nó.

dfc_ontology_query

ParâmetroTipoRequisitoSignificado e escopo
routeLocatorsarrayOpcional ou condicionalmente obrigatórioLocalizador de rota tipado emitido pelo servidor, copiado integralmente. maxItems: 20
topKintegerOpcional ou condicionalmente obrigatórioLimite de candidatos recuperados, sem garantia de cobertura completa. minimum: 1; maximum: 20
queryModestringOpcional ou condicionalmente obrigatórioModo de consulta de evidências, conforme o enum da ferramenta. enum: vector, hybrid, graph
fanoutPlanobjectOpcional ou condicionalmente obrigatórioPlano restrito de recuperação ramificada, conforme o Schema aninhado.
structuredPlanobjectOpcional ou condicionalmente obrigatórioPlano de vínculo contratual do servidor para a tabela completa do documento, não SQL.
knowledgeIdsarrayOpcional ou condicionalmente obrigatórioID da base de conhecimento no knowledgeBindings real.
querystringObrigatórioTexto da consulta ou objeto de consulta versionado exato correspondente à action.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.

dfc_knowledge_search

ParâmetroTipoRequisitoSignificado e escopo
topKintegerOpcional ou condicionalmente obrigatórioLimite de candidatos recuperados, sem garantia de cobertura completa. minimum: 1; maximum: 20
minScorenumberOpcional ou condicionalmente obrigatórioPontuação mínima de correspondência. minimum: 0; maximum: 1
knowledgeIdsarrayOpcional ou condicionalmente obrigatórioID da base de conhecimento no knowledgeBindings real.
querystringObrigatórioTexto da consulta ou objeto de consulta versionado exato correspondente à action.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
assetIdsarrayOpcional ou condicionalmente obrigatórioIDs dos ativos de documento atualmente permitidos.
retrievalStrategystringOpcional ou condicionalmente obrigatórioEstratégia de recuperação efetivamente suportada. enum: auto, hybrid_stage2

dfc_knowledge_detail

ParâmetroTipoRequisitoSignificado e escopo
qdrantIdstring / integerOpcional ou condicionalmente obrigatórioIdentificador de índice retornado pela localização real.
pageNointegerOpcional ou condicionalmente obrigatórioPágina real ou número de página da paginação.
evidenceIdstringOpcional ou condicionalmente obrigatórioID da evidência retornado pela mesma localização de conhecimento.
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: chunk, document, page_context
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
documentIdstring / integerOpcional ou condicionalmente obrigatórioID do documento da mesma localização.
radiusintegerOpcional ou condicionalmente obrigatórioFaixa de páginas adjacentes. minimum: 0; maximum: 3
chunkIdstringOpcional ou condicionalmente obrigatórioID real do fragmento da mesma localização.

dfc_table

ParâmetroTipoRequisitoSignificado e escopo
maxRowsintegerOpcional ou condicionalmente obrigatórioLimite de linhas retornadas; não define o escopo de classificação no cliente. minimum: 1; maximum: 200
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: detail, query
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
idstringOpcional ou condicionalmente obrigatórioID real do recurso de tabela, não o nome físico ou de exibição.
sqlstringOpcional ou condicionalmente obrigatórioDoris SQL somente leitura dentro do escopo de uma única ontologia, com colunas de saída explícitas.
Capítulo 31

Referência de parâmetros de ferramentas: análise e relatórios

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfc_analysis_ask

ParâmetroTipoRequisitoSignificado e escopo
questionstringObrigatórioPergunta em linguagem natural ou pergunta de acompanhamento compatível.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
languagestringOpcional ou condicionalmente obrigatórioLocale explícito da resposta ou da consulta; se omitido, aplicam-se as regras da ferramenta correspondente.
sessionIdstringOpcional ou condicionalmente obrigatórioIdentificador real da sessão no mesmo Grant.

dfc_analysis_refine

ParâmetroTipoRequisitoSignificado e escopo
branchIdstringOpcional ou condicionalmente obrigatórioIdentificador de ramificação estruturada emitido pelo servidor.
resultIdstringObrigatórioIdentificador do resultado de análise retornado originalmente.
questionstringOpcional ou condicionalmente obrigatórioPergunta em linguagem natural ou pergunta de acompanhamento compatível.
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
changeobjectOpcional ou condicionalmente obrigatórioMudança em linguagem natural ou filter_patch tipado.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
languagestringOpcional ou condicionalmente obrigatórioLocale explícito da resposta ou da consulta; se omitido, aplicam-se as regras da ferramenta correspondente.
sessionIdstringObrigatórioIdentificador real da sessão no mesmo Grant.
expectedRevisionintegerObrigatórioPré-condição da versão original do resultado ou do cabeçalho de negócio; pode ser null na criação da pergunta. minimum: 1
visualIdstringOpcional ou condicionalmente obrigatórioIdentificador de visualização vinculado à ramificação.

dfc_analysis_page

ParâmetroTipoRequisitoSignificado e escopo
branchIdstringObrigatórioIdentificador de ramificação estruturada emitido pelo servidor.
resultIdstringObrigatórioIdentificador do resultado de análise retornado originalmente.
pageNointegerObrigatórioPágina real ou número da paginação. minimum: 1; maximum: 10000
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
pageSizeintegerObrigatórioRegistros por página; conforme o limite do Schema. minimum: 1; maximum: 100
sessionIdstringObrigatórioIdentificador real da sessão no mesmo Grant.
expectedRevisionintegerObrigatórioPré-condição da versão original do resultado ou do cabeçalho de negócio; pode ser null na criação da pergunta. minimum: 1

dfc_analysis_result_get

ParâmetroTipoRequisitoSignificado e escopo
resultIdstringObrigatórioIdentificador do resultado de análise retornado originalmente.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
sessionIdstringObrigatórioIdentificador real da sessão no mesmo Grant.

dfc_analysis_cancel

ParâmetroTipoRequisitoSignificado e escopo
resultIdstringObrigatórioIdentificador do resultado de análise retornado originalmente.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
sessionIdstringObrigatórioIdentificador real da sessão no mesmo Grant.

dfc_analysis_close

ParâmetroTipoRequisitoSignificado e escopo
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
sessionIdstringObrigatórioIdentificador real da sessão no mesmo Grant.

dfc_report_create

ParâmetroTipoRequisitoSignificado e escopo
goalstringObrigatórioObjetivo da análise do relatório.
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
languagestringOpcional ou condicionalmente obrigatórioLocale explícito da resposta ou da consulta; se omitido, aplicam-se as regras da ferramenta correspondente.
titlestringOpcional ou condicionalmente obrigatórioTítulo opcional do relatório.

dfc_report_status

ParâmetroTipoRequisitoSignificado e escopo
reportIdstringObrigatórioIdentificador do relatório persistente do Grant atual.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.

dfc_report_cancel

ParâmetroTipoRequisitoSignificado e escopo
reportIdstringObrigatórioIdentificador do relatório persistente do Grant atual.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Capítulo 32

Referência de parâmetros de ferramentas: modelagem e tarefa original

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfc_ontology_agent

ParâmetroTipoRequisitoSignificado e escopo
modestringOpcional ou condicionalmente obrigatórioQUERY ou AUTHORING, com capacidades autorizadas separadamente. enum: QUERY, AUTHORING
instructionstringOpcional ou condicionalmente obrigatórioTexto do requisito do usuário; mantenha o contexto consistente com o envio. maxLength: 16000
idempotencyKeystringOpcional ou condicionalmente obrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica. maxLength: 128
actionstringObrigatórioNome da operação. Use conforme o enum atual e os parâmetros correspondentes à ação. enum: start, status, cancel
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
runIdstringOpcional ou condicionalmente obrigatórioID da tarefa original da mesma ontologia e Grant.
contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada. enum: ontology-agent-task-v1

dfc_authoring_capabilities

O objeto raiz de entrada desta ferramenta não tem campos; use um objeto arguments vazio.

dfc_artifact_context

ParâmetroTipoRequisitoSignificado e escopo
artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: CONTROL_PANEL_SPEC, VIEW_SPEC
scopeTypestringOpcional ou condicionalmente obrigatórioTipo de escopo de recursos no contrato do artefato real.
ontologyIdstringOpcional ou condicionalmente obrigatórioID real da ontologia dentro da autorização atual, preservado como string.
projectIdstringOpcional ou condicionalmente obrigatórioID do projeto autorizado atualmente.
artifactIdstringOpcional ou condicionalmente obrigatórioID real do artefato existente a editar.
instructionstringObrigatórioTexto do requisito do usuário; mantenha o contexto consistente com o envio.
variablesobjectOpcional ou condicionalmente obrigatórioObjeto de variáveis fornecido conforme o contrato retornado.
previewInputobjectOpcional ou condicionalmente obrigatórioEntrada de pré-visualização limitada, fornecida conforme o contrato.
viewportobjectOpcional ou condicionalmente obrigatórioViewport de exibição exigido pelo contrato original.

dfc_ontology_table_schema

ParâmetroTipoRequisitoSignificado e escopo
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
sourceAssetRefstringObrigatórioReferência estruturada de ativo já registrado, por exemplo table:123.
fieldsarrayObrigatórioCampos da fonte atual e declarações opcionais de tipo explícito. minItems: 1; maxItems: 64

dfc_artifact_preview

ParâmetroTipoRequisitoSignificado e escopo
proposalIdstringObrigatórioID do candidato original criado sob o Grant atual.
candidateHashstringObrigatórioHash exato do candidato original do servidor.
previewInputobjectObrigatórioEntrada de pré-visualização limitada, fornecida conforme o contrato.

dfc_artifact_status

ParâmetroTipoRequisitoSignificado e escopo
proposalIdstringOpcional ou condicionalmente obrigatórioID do candidato original criado sob o Grant atual.
planIdstringOpcional ou condicionalmente obrigatórioID do plano de aplicação imutável.

dfc_artifact_plan

ParâmetroTipoRequisitoSignificado e escopo
proposalIdstringObrigatórioID do candidato original criado sob o Grant atual.
candidateHashstringObrigatórioHash exato do candidato original do servidor.
expectedTargetVersionintegerObrigatórioPré-condição da versão de destino real atual. minimum: 0
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.

dfc_artifact_apply

ParâmetroTipoRequisitoSignificado e escopo
planIdstringObrigatórioID do plano de aplicação imutável.
planHashstringObrigatórioHash retornado pelo plano original.
approvalTokenstringObrigatórioMaterial de aprovação emitido pelo servidor original; é proibido gerá-lo por conta própria.
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.

dfc_artifact_submit

ParâmetroTipoRequisitoSignificado e escopo
Configuração 1 / artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: CONTROL_PANEL_SPEC, VIEW_SPEC
Configuração 1 / scopeTypestringOpcional ou condicionalmente obrigatórioTipo de escopo de recursos no contrato do artefato real.
Configuração 1 / ontologyIdstringOpcional ou condicionalmente obrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Configuração 1 / projectIdstringOpcional ou condicionalmente obrigatórioID do projeto autorizado atualmente.
Configuração 1 / artifactIdstringOpcional ou condicionalmente obrigatórioID real do artefato existente a editar.
Configuração 1 / instructionstringObrigatórioTexto do requisito do usuário; mantenha o contexto consistente com o envio.
Configuração 1 / variablesobjectOpcional ou condicionalmente obrigatórioObjeto de variáveis fornecido conforme o contrato retornado.
Configuração 1 / previewInputobjectOpcional ou condicionalmente obrigatórioEntrada de pré-visualização limitada, fornecida conforme o contrato.
Configuração 1 / viewportobjectOpcional ou condicionalmente obrigatórioViewport de exibição exigido pelo contrato original.
Configuração 1 / contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada.
Configuração 1 / contextHashstringObrigatórioHash completo do contexto retornado por context.
Configuração 1 / baseArtifactHashstringObrigatórioHash do artefato base retornado por context.
Configuração 1 / baseArtifactVersionintegerObrigatórioVersão base retornada por context. minimum: 0
Configuração 1 / candidateobjectObrigatórioCandidato que atende ao contrato retornado atualmente.
Configuração 1 / clientRequestIdstringObrigatórioChave de idempotência do cliente usada de forma estável pela solicitação de candidato atual.
Configuração 2 / artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: ONTOLOGY_RELEASE
Configuração 2 / contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada. 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
Configuração 2 / ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Configuração 2 / candidateHashstringObrigatórioHash exato do candidato original do servidor.
Configuração 2 / workspaceIdstringObrigatórioCoordenadas reais do workspace do candidato.
Configuração 2 / workspaceRevisionstringObrigatórioVersão exata do candidato; não usar latest.
Configuração 2 / releasesobjectObrigatórioSeleção de versões exatas fornecida conforme o contrato de publicação da ontologia.
Configuração 2 / selectionobjectObrigatórioFornece apenas coordenadas explícitas de seleção de negócio; não fornece permissões nem prova de conclusão.
Configuração 2 / idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
Configuração 3 / Configuração 1 / artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: ONTOLOGY_RELEASE
Configuração 3 / Configuração 1 / contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada. enum: ontology-workspace-create-mcp-submit-v1
Configuração 3 / Configuração 1 / ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Configuração 3 / Configuração 1 / workspaceIdstringObrigatórioCoordenadas reais do workspace do candidato.
Configuração 3 / Configuração 1 / resourcesarrayObrigatórioDeclaração do modelo original compilada pelo servidor. minItems: 1
Configuração 3 / Configuração 1 / idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
Configuração 3 / Configuração 2 / artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: ONTOLOGY_RELEASE
Configuração 3 / Configuração 2 / contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada. enum: ontology-workspace-create-mcp-submit-v2
Configuração 3 / Configuração 2 / ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Configuração 3 / Configuração 2 / workspaceIdstringObrigatórioCoordenadas reais do workspace do candidato.
Configuração 3 / Configuração 2 / resourcesarrayObrigatórioDeclaração do modelo original compilada pelo servidor. minItems: 1
Configuração 3 / Configuração 2 / idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
Configuração 3 / Configuração 2 / releaseSelectionsobjectObrigatórioreleaseId exato de cada referência publicada e o fecho de dependências.
Configuração 4 / artifactTypestringObrigatórioTipo de artefato ou de publicação de ontologia efetivamente habilitado. enum: ONTOLOGY_RELEASE
Configuração 4 / contractVersionstringObrigatórioDeve ser usada a versão exata do contrato realmente suportada. enum: ontology-initial-activation-retirement-submit-v1
Configuração 4 / ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
Configuração 4 / domainRidstringObrigatórioRID real do domínio de negócio.
Configuração 4 / consumerScopesarrayObrigatórioEscopos exatos de consumidores permitidos pelo servidor. minItems: 1; maxItems: 256
Configuração 4 / idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
Capítulo 33

Referência de parâmetros de ferramentas: entrada de conhecimento e escopo

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfc_ontology_knowledge_input_propose

ParâmetroTipoRequisitoSignificado e escopo
requestobjectObrigatórioSolicitação de entrada de negócio original; conforme o Schema aninhado completo.
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica. minLength: 1; maxLength: 128

Esta ferramenta possui um outputSchema nativo adicional. Verifique a integridade e o status da saída e os campos de autorização explicitamente definidos como false; não amplie por conta própria o significado de conclusão.

dfc_ontology_knowledge_input_preview

ParâmetroTipoRequisitoSignificado e escopo
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica. minLength: 1; maxLength: 128
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.

Esta ferramenta possui um outputSchema nativo adicional. Verifique a integridade e o status da saída e os campos de autorização explicitamente definidos como false; não amplie por conta própria o significado de conclusão.

dfc_ontology_knowledge_question_submit

ParâmetroTipoRequisitoSignificado e escopo
questionRevision$refObrigatórioVersão explícita da pergunta pendente de confirmação desta vez.
idempotencyKey$refObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica.
originalInputKey$refObrigatórioChave de idempotência correspondente à entrada de conhecimento original.
ontologyIdstringObrigatórioID real da ontologia dentro da autorização atual, preservado como string.
validUntil$refObrigatórioFim da janela de validade da pergunta, em horário UTC.
expectedRevisiononeOfObrigatórioPré-condição da versão original do resultado ou do cabeçalho de negócio; pode ser null ao criar a pergunta.
validFrom$refObrigatórioInício da janela de validade da pergunta, em horário UTC.

Esta ferramenta possui um outputSchema nativo adicional. Verifique a integridade e o status da saída e os campos de autorização explicitamente definidos como false; não amplie por conta própria o significado de conclusão.

dfc_ontology_business_scope_initialize

ParâmetroTipoRequisitoSignificado e escopo
domainRevisionIdstringObrigatórioVersão exata do domínio de negócio. minLength: 1; maxLength: 128
idempotencyKeystringObrigatórioChave de idempotência reutilizada de forma estável para a mesma operação lógica. minLength: 1; maxLength: 128
businessSystemIdstringObrigatórioID real do sistema de negócio. minLength: 1
ontologyIdstringObrigatórioID real da ontologia dentro desta autorização, preservado como string. minLength: 1
domainRidstringObrigatórioRID real do domínio de negócio. minLength: 1; maxLength: 128

Esta ferramenta possui um outputSchema nativo adicional. Verifique a integridade e o status da saída e os campos de autorização explicitamente definidos como false; não amplie por conta própria o significado de conclusão.

Capítulo 34

Referência de parâmetros de ferramentas: espaço de trabalho de negócio

Nomes completos e campos de entrada, organizados para consulta por ferramenta.

As tabelas a seguir são uma referência de leitura dos campos de entrada das ferramentas atuais do r56. Tipos aninhados completos, oneOf, obrigatoriedade condicional, restrições de pattern e alguns Schemas de saída constam em reference/mcp-tool-catalog.json; antes do envio final, ainda é necessário ler o tools/list do Grant atual. A indicação "opcional" na tabela não elimina os requisitos de validação interna das ações.

dfb_systems

O objeto raiz de entrada desta ferramenta não tem campos; use um objeto arguments vazio.

dfb_system_describe

ParâmetroTipoRequisitoSignificado e escopo
systemIdstring / integerObrigatórioIDs de sistema permitidos por este Grant de negócio.

dfb_query

ParâmetroTipoRequisitoSignificado e escopo
systemIdstring / integerObrigatórioIDs de sistema permitidos por este Grant de negócio.
queryKeystringObrigatórioChave de consulta publicada retornada por describe.
objectKeystringOpcional ou condicionalmente obrigatórioChave do objeto publicado.
pageSizeintegerOpcional ou condicionalmente obrigatórioRegistros por página; conforme o limite do Schema. minimum: 1; maximum: 100
pageintegerOpcional ou condicionalmente obrigatórioNúmero da página, a partir de 1. minimum: 1
statestringOpcional ou condicionalmente obrigatórioFiltro de status de negócio ou status do servidor.

dfb_record

ParâmetroTipoRequisitoSignificado e escopo
recordIdstring / integerObrigatórioID do registro de negócio atualmente permitido para leitura.
systemIdstring / integerObrigatórioIDs de sistema permitidos por este Grant de negócio.

dfb_work_items

ParâmetroTipoRequisitoSignificado e escopo
systemIdstring / integerObrigatórioIDs de sistema permitidos por este Grant de negócio.

dfb_action_plan

ParâmetroTipoRequisitoSignificado e escopo
expectedRecordVersionintegerOpcional ou condicionalmente obrigatórioVersão atual de bloqueio otimista do registro de destino. minimum: 1
systemIdstring / integerObrigatórioIDs de sistema permitidos por este Grant de negócio.
commandTypestringObrigatórioTipo de comando no contrato publicado.
canonicalIrHashstringObrigatórioHash atual do IR canônico publicado.
releaseIdstring / integerObrigatórioID real da versão do contrato publicado.
payloadobjectObrigatórioPayload em conformidade com o contrato de comando atual em describe.
releaseHashstringObrigatórioHash real do contrato publicado.
targetRecordIdstring / integerOpcional ou condicionalmente obrigatórioRegistro de destino real sobre o qual a operação será feita.
agentManifestHashstringObrigatórioHash real do manifest de capacidades do Agent.
planIdempotencyKeystringObrigatórioChave de idempotência estável do plano de negócio.

dfb_action_status

ParâmetroTipoRequisitoSignificado e escopo
actionPlanIdstring / integerObrigatórioID do plano de ação pertencente ao Grant de negócio atual.

dfb_action_execute

ParâmetroTipoRequisitoSignificado e escopo
approvalTokenstringOpcional ou condicionalmente obrigatórioMaterial de aprovação emitido pelo servidor original; é proibido gerá-lo por conta própria.
actionPlanIdstring / integerObrigatórioID do plano de ação pertencente ao Grant de negócio atual.