Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
614 changes: 393 additions & 221 deletions docs.json

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions pt-BR/advanced/dashboard/permissions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Permissões do Editor
description: Permita que mais membros da sua equipe atualizem sua documentação
---

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.

Se outro editor tentar atualizar a documentação enquanto estiver no plano gratuito, você verá um aviso na verificação do commit do git.

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>

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.

Saiba mais sobre nossos preços [aqui](https://mintlify.com/pricing).
104 changes: 104 additions & 0 deletions pt-BR/advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: Login Único (SSO)
description: Personalize como sua equipe pode fazer login no painel de administração
---

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!

<Note>
A funcionalidade SSO está disponível em nosso plano Enterprise.[Contate-nos](https://mintlify.com/enterprise) para saber mais!
</Note>

## Okta

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
Em `Applications`, clique para criar uma nova integração de aplicativo usando SAML 2.0.
</Step>

<Step title="Configure integration">
Insira o seguinte:

* URL de login único (fornecido pela Mintlify)
* URI de audiência (fornecido pela Mintlify)
* Formato do ID do Nome: `EmailAddress`
* Declarações de Atributos:
| Nome | Formato do nome | Valor |
| ----------- | --------------- | ---------------- |
| `firstName` | Básico | `user.firstName` |
| `lastName` | Básico | `user.lastName` |
</Step>

<Step title="Send us your IdP information">
Depois que o aplicativo estiver configurado, navegue até a aba de login e nos envie a URL dos metadados.
Nós habilitaremos a conexão do nosso lado usando essas informações.
</Step>
</Steps>
</Tab>

<Tab title="OIDC">
<Steps>
<Step title="Create an application">
Em `Applications`, clique para criar uma nova integração de aplicativo usando OIDC.
Você deve escolher o tipo de aplicativo `Web Application`.
</Step>

<Step title="Configure integration">
Selecione o tipo de concessão de código de autorização e insira o URI de Redirecionamento fornecido pela Mintlify.
</Step>

<Step title="Send us your IdP information">
Depois que o aplicativo estiver configurado, navegue até a aba Geral e localize o ID do cliente e o segredo do cliente.
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.
</Step>
</Steps>
</Tab>
</Tabs>

## Google Workspace

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
Em `Web and mobile apps`, selecione `Add custom SAML app` do menu `Add app`.

<Frame>
![](/images/gsuite-add-custom-saml-app.png)
</Frame>
</Step>

<Step title="Send us your IdP information">
Copie a URL SSO fornecida, o ID da Entidade e o certificado x509 e envie para a equipe Mintlify.

<Frame>
![](/images/gsuite-saml-metadata.png)
</Frame>
</Step>

<Step title="Configure integration">
Na página de detalhes do Provedor de serviços, insira o seguinte:

* URL ACS (fornecido pela Mintlify)
* ID da Entidade (fornecido pela Mintlify)
* Formato do ID do Nome: `EMAIL`
* ID do Nome: `Basic Information > Primary email`

<Frame>
![](/images/gsuite-sp-details.png)
</Frame>

Na próxima página, insira as seguintes declarações de atributos:

| Atributo do Diretório Google | Atributo do Aplicativo |
| ---------------------------- | ---------------------- |
| `First name` | `firstName` |
| `Last name` | `lastName` |

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!
</Step>
</Steps>
</Tab>
</Tabs>
41 changes: 41 additions & 0 deletions pt-BR/advanced/mcp/generate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: MCP Generator
description: Aprenda como configurar seu próprio Servidor MCP
---

<Tip>
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
[Instalando e usando o Servidor Mintlify MCP](/advanced/mcp/quickstart) página.
</Tip>

## Começando

Execute `npm i @mintlify/mcp` para instalar o `@mintlify/mcp` CLI.

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.

<Note>
Certifique-se de ativar o acesso OpenAPI para permitir que o servidor MCP acesse **todos**
os endpoints em sua especificação OpenAPI.
</Note>

## Iniciar o servidor MCP localmente

<Steps>
<Step title="Install the server through the CLI">
Execute o seguinte comando para instalar o servidor:

```bash
npx @mintlify/mcp add [your subdomain]
```
</Step>

<Step title="Add the authentication token if applicable">
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
(basic token)?` Caso contrário, você pode pular esta etapa.
</Step>

<Step title="Start your MCP server">
Agora você pode executar: `bash npm --prefix ~/.mcp/[your subdomain] start `
</Step>
</Steps>
97 changes: 97 additions & 0 deletions pt-BR/advanced/mcp/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: Início Rápido
description: Gere um servidor MCP para ajudar a conectar seu produto aos LLMs
---

## Introdução

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.

O Mintlify permite que você crie um servidor MCP que permite que ferramentas de IA interajam com seus documentos nestes cenários principais:

1. **Perguntas e Respostas sobre Docs**, similar ao nosso Chat de IA. Isso é automaticamente habilitado para seus documentos, sem necessidade de configuração.
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.

<Note>
Ao ativar o toggle OpenAPI, você está permitindo que o servidor MCP acesse
**todos** os endpoints em sua especificação OpenAPI.
</Note>

## Instale o servidor MCP

<Tip>
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).
</Tip>

## Exemplo de instalação com o servidor MCP do Mintlify

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.

## Inicie o servidor MCP localmente

<Steps>
<Step title="Install the server through the CLI">
Execute o seguinte comando para instalar o servidor:

```bash
npx @mintlify/mcp add mintlify
```
</Step>

<Step title="Add the authentication token">
A seguinte resposta será dada após executar o comando anterior:

```
> What is the Authorization (basic token)?
```

Usando sua chave de chat API, copie o token de autenticação e cole-o no CLI.
</Step>

<Step title="Start your MCP server">
Agora você pode executar:

```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
</Steps>

## Use seu servidor com Claude

<Note>
Baixe o[Aplicativo Desktop Claude](https://claude.ai/download)
</Note>

Depois de ter o Aplicativo Desktop Claude instalado, siga estes passos:

<Steps>
<Step title="Navigate to the Settings > Developer" />

<Step title="Click on Edit Config">
Adicione o seguinte ao`claude_desktop_config.json`:

```json
{
"mcpServers": {
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>

<Step title="If you see the hammer icon, you're all set!">
Se você clicar nele, deverá ver as Ferramentas MCP disponíveis em seu servidor.

<Frame>
![Claude MCP](/images/mcp-with-claude.png)
</Frame>
</Step>
</Steps>
3 changes: 3 additions & 0 deletions pt-BR/advanced/rest-api/chat/create-topic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/topic
---
3 changes: 3 additions & 0 deletions pt-BR/advanced/rest-api/chat/generate-message.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/message
---
38 changes: 38 additions & 0 deletions pt-BR/advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Overview
---

## Acionar Atualizações

Você pode aproveitar a API REST para acionar programaticamente uma atualização quando desejar.

<Info>
Embora o caso de uso principal seja acionar atualizações, adicionaremos cada vez mais
funcionalidades à API ao longo do tempo. Deixe-nos saber o que mais você quer ver em
[nossa comunidade](https://mintlify.com/community)!
</Info>

## Autenticação

Você pode gerar uma chave de API através do
[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.

<Frame>
<img src="/images/external-api-key.png" />
</Frame>

## Chave de API Admin

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).

## Chave de API de Chat

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.

As respostas incluem citações para que você possa direcionar seus usuários aos lugares certos onde precisam obter ajuda.

<Note>
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.
</Note>

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).
3 changes: 3 additions & 0 deletions pt-BR/advanced/rest-api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: GET /project/update-status/{statusId}
---
3 changes: 3 additions & 0 deletions pt-BR/advanced/rest-api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /project/update/{projectId}
---
75 changes: 75 additions & 0 deletions pt-BR/advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Cloudflare
description: Hospede documentação em um subpath /docs usando Cloudflare Workers
---

## Criar Worker Cloudflare

Navegue até o `Workers & Pages > Create application > Create worker`. Você deve ver a seguinte tela onde você pode criar um novo worker do Cloudflare.

<Frame>
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
</Frame>

<Warning>
Lembre-se: Se seu provedor DNS for o Cloudflare, você não deve usar proxy para o registro CNAME
</Warning>

### Adicionar domínio personalizado

Depois que o worker for criado, clique em `Configure worker`. Navegue até o worker
`Settings > Triggers`. Clique em `Add Custom Domain` para adicionar seu domínio desejado à lista - recomendamos que você adicione tanto a versão com quanto sem `www.`
prefixado ao domínio.

<Frame>
<img alt="Cloudflare worker custom domain" src="/images/cloudflare/custom-domain.png" />
</Frame>

Se você tiver problemas para configurar um subdiretório personalizado,
[entre em contato com nossa equipe de suporte](mailto:[email protected]) e nós o ajudaremos a atualizar sua hospedagem conosco.

### Editar Script do Worker

Clique em `Edit Code` e adicione o seguinte script no código do worker.

<Frame>
<img alt="Cloudflare edit code" src="/images/cloudflare/edit-code.png" />
</Frame>

<Tip>
Edite `DOCS_URL` substituindo `[SUBDOMAIN]` pelo seu subdomínio único e`CUSTOM_URL` pela URL base do seu site.
</Tip>

```javascript
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// If the request is to the docs subdirectory
if (/^\/docs/.test(urlObject.pathname)) {
// Then Proxy to Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";

let url = new URL(request.url);
url.hostname = DOCS_URL;

let proxyRequest = new Request(url, request);

proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");

return await fetch(proxyRequest);
}
} catch (error) {
// if no action found, play the regular request
return await fetch(request);
}
}
```

Clique em `Deploy` e aguarde a propagação das alterações (pode levar até algumas horas).
Loading