Skip to content

Commit d1b9c21

Browse files
mintlify-development[bot]mintlify-development[bot]
authored
Documentation edits made through Mintlify web editor
1 parent 3ccba78 commit d1b9c21

File tree

107 files changed

+9297
-221
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+9297
-221
lines changed

‎docs.json‎

Lines changed: 393 additions & 221 deletions
Large diffs are not rendered by default.

‎pt-BR/advanced/dashboard/permissions.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Permissões do Editor
3+
description: Permita que mais membros da sua equipe atualizem sua documentação
4+
---
5+
6+
O membro da equipe que criou sua documentação inicial terá acesso para atualizá-la, desde que faça push para o repositório de documentação com a mesma conta do GitHub que foi usada ao se cadastrar no Mintlify.
7+
8+
Se outro editor tentar atualizar a documentação enquanto estiver no plano gratuito, você verá um aviso na verificação do commit do git.
9+
10+
<Frame>
11+
<img className="rounded-md" src="/images/editor-gate.png" />
12+
</Frame>
13+
14+
Nos detalhes do aviso de verificação do git, você encontrará o link para fazer upgrade do seu plano. Você também pode fazer upgrade do seu plano no [painel](https://dashboard.mintlify.com) para permitir que editores ilimitados atualizem sua documentação. Depois de fazer upgrade do seu plano, acione uma atualização manual ou faça push de outra alteração para implantar suas atualizações.
15+
16+
Saiba mais sobre nossos preços [aqui](https://mintlify.com/pricing).

‎pt-BR/advanced/dashboard/sso.mdx‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Login Único (SSO)
3+
description: Personalize como sua equipe pode fazer login no painel de administração
4+
---
5+
6+
Use login único para seu painel através de SAML e OIDC. Se você usa Okta ou Google Workspace, temos documentação específica para configurar SSO, mas se você usa outro provedor, entre em contato conosco!
7+
8+
<Note>
9+
A funcionalidade SSO está disponível em nosso plano Enterprise.[Contate-nos](https://mintlify.com/enterprise) para saber mais!
10+
</Note>
11+
12+
## Okta
13+
14+
<Tabs>
15+
<Tab title="SAML">
16+
<Steps>
17+
<Step title="Create an application">
18+
Em `Applications`, clique para criar uma nova integração de aplicativo usando SAML 2.0.
19+
</Step>
20+
21+
<Step title="Configure integration">
22+
Insira o seguinte:
23+
24+
* URL de login único (fornecido pela Mintlify)
25+
* URI de audiência (fornecido pela Mintlify)
26+
* Formato do ID do Nome: `EmailAddress`
27+
* Declarações de Atributos:
28+
| Nome | Formato do nome | Valor |
29+
| ----------- | --------------- | ---------------- |
30+
| `firstName` | Básico | `user.firstName` |
31+
| `lastName` | Básico | `user.lastName` |
32+
</Step>
33+
34+
<Step title="Send us your IdP information">
35+
Depois que o aplicativo estiver configurado, navegue até a aba de login e nos envie a URL dos metadados.
36+
Nós habilitaremos a conexão do nosso lado usando essas informações.
37+
</Step>
38+
</Steps>
39+
</Tab>
40+
41+
<Tab title="OIDC">
42+
<Steps>
43+
<Step title="Create an application">
44+
Em `Applications`, clique para criar uma nova integração de aplicativo usando OIDC.
45+
Você deve escolher o tipo de aplicativo `Web Application`.
46+
</Step>
47+
48+
<Step title="Configure integration">
49+
Selecione o tipo de concessão de código de autorização e insira o URI de Redirecionamento fornecido pela Mintlify.
50+
</Step>
51+
52+
<Step title="Send us your IdP information">
53+
Depois que o aplicativo estiver configurado, navegue até a aba Geral e localize o ID do cliente e o segredo do cliente.
54+
Por favor, nos forneça esses dados de forma segura, junto com a URL da sua instância Okta (por exemplo, `<your-tenant-name>.okta.com`). Você pode enviar esses dados através de um serviço como 1Password ou SendSafely.
55+
</Step>
56+
</Steps>
57+
</Tab>
58+
</Tabs>
59+
60+
## Google Workspace
61+
62+
<Tabs>
63+
<Tab title="SAML">
64+
<Steps>
65+
<Step title="Create an application">
66+
Em `Web and mobile apps`, selecione `Add custom SAML app` do menu `Add app`.
67+
68+
<Frame>
69+
![](/images/gsuite-add-custom-saml-app.png)
70+
</Frame>
71+
</Step>
72+
73+
<Step title="Send us your IdP information">
74+
Copie a URL SSO fornecida, o ID da Entidade e o certificado x509 e envie para a equipe Mintlify.
75+
76+
<Frame>
77+
![](/images/gsuite-saml-metadata.png)
78+
</Frame>
79+
</Step>
80+
81+
<Step title="Configure integration">
82+
Na página de detalhes do Provedor de serviços, insira o seguinte:
83+
84+
* URL ACS (fornecido pela Mintlify)
85+
* ID da Entidade (fornecido pela Mintlify)
86+
* Formato do ID do Nome: `EMAIL`
87+
* ID do Nome: `Basic Information > Primary email`
88+
89+
<Frame>
90+
![](/images/gsuite-sp-details.png)
91+
</Frame>
92+
93+
Na próxima página, insira as seguintes declarações de atributos:
94+
95+
| Atributo do Diretório Google | Atributo do Aplicativo |
96+
| ---------------------------- | ---------------------- |
97+
| `First name` | `firstName` |
98+
| `Last name` | `lastName` |
99+
100+
Depois que esta etapa estiver concluída e os usuários forem atribuídos ao aplicativo, avise nossa equipe e habilitaremos o SSO para sua conta!
101+
</Step>
102+
</Steps>
103+
</Tab>
104+
</Tabs>

‎pt-BR/advanced/mcp/generate.mdx‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: MCP Generator
3+
description: Aprenda como configurar seu próprio Servidor MCP
4+
---
5+
6+
<Tip>
7+
Esta página é dedicada à configuração do seu próprio Servidor MCP. Se você está procurando informações sobre como usar o Servidor Mintlify MCP, consulte a
8+
[Instalando e usando o Servidor Mintlify MCP](/advanced/mcp/quickstart) página.
9+
</Tip>
10+
11+
## Começando
12+
13+
Execute `npm i @mintlify/mcp` para instalar o `@mintlify/mcp` CLI.
14+
15+
No [painel](https://dashboard.mintlify.com/products/mcp) vá para `MCP Server`, nesta página alterne para ver seu comando de instalação único. Este é o comando para instalar seu Servidor MCP com o `@mintlify/mcp` CLI.
16+
17+
<Note>
18+
Certifique-se de ativar o acesso OpenAPI para permitir que o servidor MCP acesse **todos**
19+
os endpoints em sua especificação OpenAPI.
20+
</Note>
21+
22+
## Iniciar o servidor MCP localmente
23+
24+
<Steps>
25+
<Step title="Install the server through the CLI">
26+
Execute o seguinte comando para instalar o servidor:
27+
28+
```bash
29+
npx @mintlify/mcp add [your subdomain]
30+
```
31+
</Step>
32+
33+
<Step title="Add the authentication token if applicable">
34+
Se sua API requer um token de autenticação, instrua seu cliente final a obtê-lo e aplicá-lo quando receber esta resposta: `> What is the Authorization
35+
(basic token)?` Caso contrário, você pode pular esta etapa.
36+
</Step>
37+
38+
<Step title="Start your MCP server">
39+
Agora você pode executar: `bash npm --prefix ~/.mcp/[your subdomain] start `
40+
</Step>
41+
</Steps>

‎pt-BR/advanced/mcp/quickstart.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Início Rápido
3+
description: Gere um servidor MCP para ajudar a conectar seu produto aos LLMs
4+
---
5+
6+
## Introdução
7+
8+
O Gerador MCP é uma ferramenta CLI que gera um servidor MCP baseado na documentação da sua empresa e especificação OpenAPI, se disponível. Ele recebe sua documentação e uma especificação OpenAPI e gera um servidor MCP que pode ser usado com qualquer cliente MCP. O Gerador MCP é disponibilizado via[pacote npm](https://www.npmjs.com/package/mcp) e gera um servidor MCP que pode ser usado com qualquer cliente MCP.
9+
10+
O Mintlify permite que você crie um servidor MCP que permite que ferramentas de IA interajam com seus documentos nestes cenários principais:
11+
12+
1. **Perguntas e Respostas sobre Docs**, similar ao nosso Chat de IA. Isso é automaticamente habilitado para seus documentos, sem necessidade de configuração.
13+
2. **Consulta de API em tempo real**, se você tem uma especificação OpenAPI, vá para o`Mintlify Dashboard > Products > MCP Server` e ative o toggle para habilitar sua especificação OpenAPI.
14+
15+
<Note>
16+
Ao ativar o toggle OpenAPI, você está permitindo que o servidor MCP acesse
17+
**todos** os endpoints em sua especificação OpenAPI.
18+
</Note>
19+
20+
## Instale o servidor MCP
21+
22+
<Tip>
23+
Esta página é dedicada ao Servidor MCP do Mintlify. Se você está procurando informações sobre como gerar seu MCP, consulte a página[Gerador MCP](/advanced/mcp/generate).
24+
</Tip>
25+
26+
## Exemplo de instalação com o servidor MCP do Mintlify
27+
28+
Para usar o servidor MCP do Mintlify você precisará de uma[chave de API](https://mintlify.com/docs/advanced/rest-api/overview#authentication) da sua conta Mintlify. Se você não tem uma, navegue até`Settings > API Keys > Chat API Key` e crie uma nova chave.
29+
30+
## Inicie o servidor MCP localmente
31+
32+
<Steps>
33+
<Step title="Install the server through the CLI">
34+
Execute o seguinte comando para instalar o servidor:
35+
36+
```bash
37+
npx @mintlify/mcp add mintlify
38+
```
39+
</Step>
40+
41+
<Step title="Add the authentication token">
42+
A seguinte resposta será dada após executar o comando anterior:
43+
44+
```
45+
> What is the Authorization (basic token)?
46+
```
47+
48+
Usando sua chave de chat API, copie o token de autenticação e cole-o no CLI.
49+
</Step>
50+
51+
<Step title="Start your MCP server">
52+
Agora você pode executar:
53+
54+
```bash
55+
npm --prefix ~/.mcp/mintlify start
56+
```
57+
</Step>
58+
</Steps>
59+
60+
## Use seu servidor com Claude
61+
62+
<Note>
63+
Baixe o[Aplicativo Desktop Claude](https://claude.ai/download)
64+
</Note>
65+
66+
Depois de ter o Aplicativo Desktop Claude instalado, siga estes passos:
67+
68+
<Steps>
69+
<Step title="Navigate to the Settings > Developer" />
70+
71+
<Step title="Click on Edit Config">
72+
Adicione o seguinte ao`claude_desktop_config.json`:
73+
74+
```json
75+
{
76+
"mcpServers": {
77+
"mintlify": {
78+
"command": "npm",
79+
"args": [
80+
"--prefix",
81+
"~/.mcp/mintlify",
82+
"start"
83+
]
84+
}
85+
}
86+
}
87+
```
88+
</Step>
89+
90+
<Step title="If you see the hammer icon, you're all set!">
91+
Se você clicar nele, deverá ver as Ferramentas MCP disponíveis em seu servidor.
92+
93+
<Frame>
94+
![Claude MCP](/images/mcp-with-claude.png)
95+
</Frame>
96+
</Step>
97+
</Steps>

‎pt-BR/advanced/rest-api/chat/create-topic.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/topic
3+
---

‎pt-BR/advanced/rest-api/chat/generate-message.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/message
3+
---

‎pt-BR/advanced/rest-api/overview.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Overview
3+
---
4+
5+
## Acionar Atualizações
6+
7+
Você pode aproveitar a API REST para acionar programaticamente uma atualização quando desejar.
8+
9+
<Info>
10+
Embora o caso de uso principal seja acionar atualizações, adicionaremos cada vez mais
11+
funcionalidades à API ao longo do tempo. Deixe-nos saber o que mais você quer ver em
12+
[nossa comunidade](https://mintlify.com/community)!
13+
</Info>
14+
15+
## Autenticação
16+
17+
Você pode gerar uma chave de API através do
18+
[painel](https://dashboard.mintlify.com/settings/organization/api-keys). A chave de API está associada a toda a organização e pode ser usada em várias implantações.
19+
20+
<Frame>
21+
<img src="/images/external-api-key.png" />
22+
</Frame>
23+
24+
## Chave de API Admin
25+
26+
A chave de API Admin é usada para a maioria das APIs. Ela é usada para acionar atualizações através do [endpoint de Atualização](/advanced/rest-api/update/trigger).
27+
28+
## Chave de API de Chat
29+
30+
A API de Chat permite que você incorpore a experiência de chat com IA baseada em seus documentos e continuamente atualizada em qualquer aplicação de sua escolha.
31+
32+
As respostas incluem citações para que você possa direcionar seus usuários aos lugares certos onde precisam obter ajuda.
33+
34+
<Note>
35+
O token da API de Chat é um token público que pode ser referenciado em seu código frontend, enquanto a chave de API é um token do lado do servidor que deve ser mantido em segredo.
36+
</Note>
37+
38+
Agora que você tem uma chave de API, confira nosso [exemplo](https://github.com/mintlify/discovery-api-example) para saber como usar a API para chat com IA. Você também pode ver uma versão implantada deste exemplo em [chat.mintlify.com](https://chat.mintlify.com).

‎pt-BR/advanced/rest-api/update/status.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: GET /project/update-status/{statusId}
3+
---

‎pt-BR/advanced/rest-api/update/trigger.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /project/update/{projectId}
3+
---

0 commit comments

Comments
 (0)