You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: advanced/dashboard/permissions.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@ title: 'Editor Permissions'
3
3
description: 'Allow more members of your team to update your docs'
4
4
---
5
5
6
-
The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify.
6
+
The team member who created your initial docs will have update access to your documentation, as long as they push to your documentation repository with the same GitHub account that was used while signing up for Mintlify.
7
7
8
-
If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check.
8
+
If another editor attempts to update the docs while on the free plan, you will see a warning in your Git commit check.
In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates.
14
+
In the details of the Git check warning, you'll find a link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates.
15
15
16
-
Learn more about our pricing [here](https://mintlify.com/pricing).
16
+
Learn more about our pricing [here](https://mintlify.com/pricing).
Copy file name to clipboardExpand all lines: advanced/dashboard/sso.mdx
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: "Single Sign-On (SSO)"
3
3
description: "Customize how your team can login to your admin dashboard"
4
4
---
5
5
6
-
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!
6
+
Use Single Sign-On (SSO) to access your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO. If you use another provider, please contact us!
7
7
8
8
<Note>
9
9
SSO functionality is available on our Enterprise plan. [Contact
@@ -20,33 +20,33 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl
20
20
</Step>
21
21
<Steptitle="Configure integration">
22
22
Enter the following:
23
-
* Single sign-on URL (provided by Mintlify)
23
+
* Single Sign-On URL (provided by Mintlify)
24
24
* Audience URI (provided by Mintlify)
25
25
* Name ID Format: `EmailAddress`
26
26
* Attribute Statements:
27
-
| Name | Name format | Value
27
+
| Name | Name Format | Value
28
28
| ---- | ----------- | -----
29
29
| `firstName` | Basic | `user.firstName` |
30
30
| `lastName` | Basic | `user.lastName` |
31
31
</Step>
32
32
<Steptitle="Send us your IdP information">
33
-
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
33
+
Once the application is set up, navigate to the Sign-On tab and send us the metadata URL.
34
34
We'll enable the connection from our side using this information.
35
35
</Step>
36
36
</Steps>
37
37
</Tab>
38
38
<Tabtitle="OIDC">
39
39
<Steps>
40
40
<Steptitle="Create an application">
41
-
Under `Applications`, click to create a new app integration using OIDC.
41
+
Under `Applications`, click to create a new app integration using OpenID Connect (OIDC).
42
42
You should choose the `Web Application` application type.
43
43
</Step>
44
44
<Steptitle="Configure integration">
45
-
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
45
+
Select the Authorization Code grant type and enter the Redirect URI provided by Mintlify.
46
46
</Step>
47
47
<Steptitle="Send us your IdP information">
48
-
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
49
-
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
48
+
Once the application is set up, navigate to the General tab and locate the Client ID & Client Secret.
49
+
Please securely provide us with these, along with your Okta instance URL (e.g.,`<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
50
50
</Step>
51
51
</Steps>
52
52
</Tab>
@@ -64,23 +64,23 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl
64
64
</Frame>
65
65
</Step>
66
66
<Steptitle="Send us your IdP information">
67
-
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
67
+
Copy the provided SSO URL, Entity ID, and X.509 certificate and send it to the Mintlify team.
68
68
<Frame>
69
69
70
70
</Frame>
71
71
</Step>
72
72
<Steptitle="Configure integration">
73
-
On the Service provider details page, enter the following:
73
+
On the Service Provider details page, enter the following:
74
74
* ACS URL (provided by Mintlify)
75
75
* Entity ID (provided by Mintlify)
76
-
* Name ID format: `EMAIL`
76
+
* Name ID Format: `EMAIL`
77
77
* Name ID: `Basic Information > Primary email`
78
78
79
79
<Frame>
80
80
81
81
</Frame>
82
82
83
-
On the next page, enter the following attribute statements:
83
+
On the next page, enter the following Attribute Statements:
84
84
| Google Directory Attribute | App Attribute |
85
85
| -------------------------- | ------------- |
86
86
| `First name` | `firstName` |
@@ -90,5 +90,4 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl
Copy file name to clipboardExpand all lines: advanced/mcp/generate.mdx
+23-16Lines changed: 23 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,30 +9,37 @@ description: "Learn how to set up your own MCP Server"
9
9
[Installing and using the Mintlify MCP Server](/advanced/mcp/quickstart) page.
10
10
</Tip>
11
11
12
-
## Get started
12
+
## Get Started
13
13
14
-
Run `npm i mcp` to install the `mcp` CLI.
14
+
Run `npm i mcp` to install the MCP CLI.
15
15
16
-
In the [dashboard](https://dashboard.mintlify.com/products/mcp) go to `MCP Server`, on this page toggle to see your unique installation command. This is the command to install your MCP Server with the `mcp` CLI.
16
+
In the [dashboard](https://dashboard.mintlify.com/products/mcp), navigate to the `MCP Server` section. On this page, toggle the view to see your unique installation command. This command will install your MCP Server using the MCP CLI.
17
17
18
18
<Note>
19
-
Make sure to toggle OpenAPI access to allow the MCP server to access **all**
20
-
endpoints in your OpenAPI spec.
19
+
Make sure to toggle OpenAPI access to allow the MCP Server to access **all**
20
+
endpoints in your OpenAPI specification.
21
21
</Note>
22
22
23
-
## Start the MCP server locally
23
+
## Start the MCP Server Locally
24
24
25
25
<Steps>
26
-
<Steptitle="Install the server through the CLI">
27
-
Run the following command to install the server: ```bash npx mcp add [your
28
-
subdomain] ```
26
+
<Steptitle="Install the Server through the CLI">
27
+
Run the following command to install the server:
28
+
```bash
29
+
npx mcp add [your subdomain]
30
+
```
29
31
</Step>
30
-
<Steptitle="Add the authentication token if applicable">
31
-
If your API requires an authentication token, tell your end-customer to get
32
-
it and apply it when given this response: ``` > What is the Authorization
33
-
(basic token)? ``` Otherwise, you can skip this step.
32
+
<Steptitle="Add the Authentication Token (if applicable)">
33
+
If your API requires an authentication token, instruct your end-customer to provide it when prompted with this response:
34
+
```
35
+
> What is the Authorization (basic token)?
36
+
```
37
+
If authentication is not required, you can skip this step.
34
38
</Step>
35
-
<Steptitle="Start your MCP server">
36
-
You can now run: ```bash npm --prefix ~/.mcp/[your subdomain] start ```
Copy file name to clipboardExpand all lines: advanced/rest-api/overview.mdx
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,36 +7,35 @@ title: Overview
7
7
You can leverage the REST API to programmatically trigger an update when desired.
8
8
9
9
<Info>
10
-
While the primary use-case will be to trigger updates, we will be adding more and more
11
-
functionality to the API overtime. Let us know what else you want to see in
10
+
While the primary use case will be to trigger updates, we will be adding more functionality to the API over time. Let us know what else you would like to see in
12
11
[our community](https://mintlify.com/community)!
13
12
</Info>
14
13
15
14
## Authentication
16
15
17
16
You can generate an API key through
18
17
[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is
19
-
associated with the entire org and can be used across multiple deployments.
18
+
associated with the entire organization and can be used across multiple deployments.
20
19
21
20
<Frame>
22
21
<imgsrc="/images/external-api-key.png" />
23
22
</Frame>
24
23
25
-
## Admin API key
24
+
## Admin API Key
26
25
27
26
The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/advanced/rest-api/update/trigger).
28
27
29
-
## Chat API key
28
+
## Chat API Key
30
29
31
-
The Chat API allows you to embed the AI chat experience grounded in your docs and continually kept up to date into any application of your choosing.
30
+
The Chat API allows you to embed an AI chat experience into any application of your choosing. This chat experience is grounded in your documentation and continuously kept up to date.
32
31
33
-
Responses include citations so you can point your users to the right places they need to get help.
32
+
Responses include citations, allowing you to point your users to the specific documentation pages they need for help.
34
33
35
34
<Note>
36
35
The Chat API token is a public token that can be referenced in your
37
-
frontend code whereas the API key is a server-side token that should be kept
36
+
frontend code, whereas the API key is a server-side token that should be kept
38
37
secret.
39
38
</Note>
40
39
41
40
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
42
-
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
41
+
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?v=4&size=40){kind=avatar}
0 commit comments