Skip to content

Commit b5bb74f

Browse files
Merge pull request #290 from auth0/fix/documentation-grammar-and-style
Fix documentation grammar, punctuation, and style issues
2 parents 7584f0a + 7e015d6 commit b5bb74f

16 files changed

+60
-60
lines changed

auth4genai/mcp/get-started/authorization-for-your-mcp-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ import MCPGetStartedTestingInstructions from "/snippets/mcp/get-started/testing-
1212

1313
## Next steps
1414

15-
* To set up first-party tool calling, complete the [Call Your APIs on User's Behalf](./call-your-apis-on-users-behalf) quickstart.
15+
* To set up first-party tool calling, complete the [Call Your APIs on a User's Behalf](./call-your-apis-on-users-behalf) quickstart.

auth4genai/mcp/get-started/call-your-apis-on-users-behalf.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Call Your API on User's Behalf
2+
title: Call Your API on a User's Behalf
33
description: Learn how to call an Auth0-protected API from your MCP server.
4-
sidebarTitle: Call Your API on User's Behalf
4+
sidebarTitle: Call Your API on a User's Behalf
55
---
66

77
import MCPGetStartedPrerequisites from "/snippets/mcp/get-started/pre-reqs/prerequisites.mdx";
@@ -55,7 +55,7 @@ auth0 api post clients --data '{
5555

5656
The output of the command will be a JSON object with the `client_id` and `client_secret` of the newly created client, which will be used in the next steps to configure the MCP server environment.
5757

58-
Next, we need to indicate Auth0 that the client can use Custom Token Exchange.
58+
Next, we need to indicate to Auth0 that the client can use Custom Token Exchange.
5959

6060
```shell
6161
CLIENT_ID=$(jq -r '.client_id' auth0-app-details.json) \
@@ -84,7 +84,7 @@ auth0 api post resource-servers --data '{
8484
}' | jq -r '"Audience: " + .identifier'
8585
```
8686

87-
Save the `Audience` from the command output, you'll need it on a later step.
87+
Save the `Audience` from the command output; you'll need it in a later step.
8888

8989

9090
<Tabs>
@@ -124,7 +124,7 @@ npm install
124124

125125
## Create your environment file
126126

127-
In the `fastmcp-mcp-customtokenexchange-js` directory, run the following commnd to create a new `.env` file populated with all the required environment variables:
127+
In the `fastmcp-mcp-customtokenexchange-js` directory, run the following command to create a new `.env` file populated with all the required environment variables:
128128

129129
```shell wrap lines expandable
130130
CLIENT_ID=$(jq -r '.client_id' auth0-app-details.json) \
@@ -152,15 +152,15 @@ To get your Auth0 application’s `AUTH0_DOMAIN`, run the following command:
152152
auth0 tenants list
153153
```
154154

155-
Copy the domain under `TENANT` from the output and update the corresponding variable on the `.env`.
155+
Copy the domain under `TENANT` from the output and update the corresponding variable in the `.env` file.
156156

157-
For `MCP_AUTH0_CLIENT_ID` and `MCP_AUTH0_CLIENT_SECRET` you will use the values obtained on the [Create an Application for your MCP server](./call-your-apis-on-users-behalf#create-an-application-for-your-mcp-server) step.
157+
For `MCP_AUTH0_CLIENT_ID` and `MCP_AUTH0_CLIENT_SECRET` you will use the values obtained from the [Create an Application for your MCP server](./call-your-apis-on-users-behalf#create-an-application-for-your-mcp-server) step.
158158

159159
## Use Custom Token Exchange Action
160160

161161
This Action is the server-side logic Auth0 executes to perform the token exchange. It is necessary because the MCP server receives an access token from the client (with the MCP server as its audience) and must exchange it for a new token (with the upstream API as the audience). This Action validates the original token and mints the new one.
162162

163-
The Custom Token Exchange Action, available as a part of Custom Token Exchange Early Access. Navigate to [the On-behalf-of token exchange for first-party apps template available here](https://manage.auth0.com/#/actions/library/templates/templates/daeda4e8-8da2-4abb-afb5-ac09df0ebb2a) and click on **Use This Template**.
163+
The Custom Token Exchange Action is available as part of Custom Token Exchange Early Access. Navigate to [the On-behalf-of token exchange for first-party apps template available here](https://manage.auth0.com/#/actions/library/templates/templates/daeda4e8-8da2-4abb-afb5-ac09df0ebb2a) and click on **Use This Template**.
164164

165165
<Frame>
166166
<img
@@ -179,9 +179,9 @@ This will open a modal for you to name the action:
179179
/>
180180
</Frame>
181181

182-
Once the action is created you can **Deploy** it. When you deploy the Action, Auth0 assigns it an Action ID. You still need to add your custom logic to the Action, but first, get the Action ID to create the Custom Token Exchange Profile.
182+
Once the action is created, you can **Deploy** it. When you deploy the Action, Auth0 assigns it an Action ID. You still need to add your custom logic to the Action, but first, get the Action ID to create the Custom Token Exchange Profile.
183183

184-
## Setup the token exchange profile
184+
## Set up the token exchange profile
185185

186186
<CreateProfile />
187187

auth4genai/mcp/get-started/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ mode: "wide"
77

88
## Quickstarts
99

10-
Secure your MCP servers, enable API access, and implement standards-based client registration
10+
Secure your MCP servers, enable API access, and implement standards-based client registration.
1111

1212
<Columns cols={2}>
1313

auth4genai/mcp/guides/registering-your-mcp-client-application.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can register your client in two ways: statically or dynamically. For most sc
1717
This method is recommended because it offers several key advantages:
1818

1919
* **Enhanced Security**: You explicitly approve every client, preventing unauthorized or malicious applications from registering themselves and accessing your system.
20-
* **Predictable Configuration**: The client_id and other settings are known in advance, simplifying deployment and configuration management.
20+
* **Predictable Configuration**: The `client_id` and other settings are known in advance, simplifying deployment and configuration management.
2121
* **Clear Auditing**: There is a clear, auditable trail for every client created, linking it to a specific developer or team.
2222
* **Principle of Least Privilege**: You can precisely configure the exact permissions (scopes) and settings for each client from the outset.
2323

@@ -113,7 +113,7 @@ For a client to interact with your server, the MCP specification requires you to
113113

114114
1. **Use the `WWW-Authenticate` Header for 401 Errors**
115115

116-
When a client makes a request without a valid token, your server must return a `401 Unauthorized` status. Crucially, this response must include the `WWW-Authenticate` header, pointing to the metadata URL you configured above. This signals to the client that authentication is required and tells it exactly.
116+
When a client makes a request without a valid token, your server must return a `401 Unauthorized` status. Crucially, this response must include the `WWW-Authenticate` header, pointing to the metadata URL you configured above. This signals to the client that authentication is required and tells it exactly where to obtain the authorization metadata.
117117

118118
2. **Announce Your Auth Server with Protected Resource Metadata ([RFC 9728](https://datatracker.ietf.org/doc/html/rfc9728))**
119119

auth4genai/mcp/guides/resource-param-compatibility-profile.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Once the **Resource Parameter Compatibility Profile** is enabled, Auth0 will use
4444
/>
4545
</Frame>
4646

47-
If both the `resource` and `audience` are available, the `audience` will still be used. Auth0 will not forward the `resource` to upstream Identity Providers (IdPs), [learn more](./resource-param-compatibility-profile#resource-parameter-forwarding-to-upstream-identity-provider-idp).
47+
If both the `resource` and `audience` are available, the `audience` will still be used. Auth0 will not forward the `resource` to upstream Identity Providers (IdPs). [Learn more](./resource-param-compatibility-profile#resource-parameter-forwarding-to-upstream-identity-provider-idp).
4848

49-
*RFC 8707 requires the `resource` parameter to [be an absolute URI](https://www.rfc-editor.org/rfc/rfc8707.html#name-resource-parameter), to conform with RFC 8707 we recommend defining your resource server identifiers (API identifiers) in [URI format](https://datatracker.ietf.org/doc/html/rfc3986). Using an absolute URI as the identifier of your MCP Server is also a requirement from the MCP Authorization specification.*
49+
*RFC 8707 requires the `resource` parameter to [be an absolute URI](https://www.rfc-editor.org/rfc/rfc8707.html#name-resource-parameter), to conform with RFC 8707, we recommend defining your resource server identifiers (API identifiers) in [URI format](https://datatracker.ietf.org/doc/html/rfc3986). Using an absolute URI as the identifier of your MCP Server is also a requirement from the MCP Authorization specification.*
5050

5151
## Supported flows
5252

@@ -62,11 +62,11 @@ The `resource` parameter is supported in the following flows:
6262

6363
When federating to an upstream IdP, Auth0 provides a way for initiating clients to [forward parameters](https://auth0.com/docs/authenticate/identity-providers/pass-parameters-to-idps). In the documentation, notice that `resource` is one of the parameters [available for forwarding to upstream IdPs](https://auth0.com/docs/authenticate/identity-providers/pass-parameters-to-idps#available-fields).
6464

65-
To avoid leaking access token details, Auth0 will not forward the resource parameter to upstream IdPs while the Resource Parameter Compatibility Profile is enabled.
65+
RFC 8707 requires the `resource` parameter to be an absolute URI. To conform with RFC 8707, we recommend defining your resource server identifiers (API identifiers) in URI format. To avoid leaking access token details, Auth0 will not forward the resource parameter to upstream IdPs while the Resource Parameter Compatibility Profile is enabled.
6666

6767
* Resource Parameter Compatibility **disabled** (default behavior):
6868
* `resource` is available as an upstream IdP parameter.
6969
* Resource Parameter Compatibility **enabled**:
7070
* `resource` is not available as an upstream IdP parameter, and will not be forwarded.
7171

72-
<Note>If passing the resource parameter to an upstream IdP, Resource Parameter Compatibility Profile should not be enabled.</Note>
72+
<Note>If passing the resource parameter to an upstream IdP, the Resource Parameter Compatibility Profile should not be enabled.</Note>

auth4genai/mcp/guides/test-your-mcp-server-with-mcp-inspector.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ First, make sure your MCP server is running in a separate terminal. Then, open a
1818
npx @modelcontextprotocol/inspector@latest
1919
```
2020

21-
This will open the MCP Inspector interface on your default browser.
21+
This will open the MCP Inspector interface in your default browser.
2222

2323
<Frame>
2424
<img
@@ -34,15 +34,15 @@ Once the Inspector is open, you need to configure it to connect to your local MC
3434
1. Set the **Transport Type** to `Streamable HTTP`.
3535
2. Enter your server's URL, which is typically `http://localhost:3001/mcp`.
3636

37-
In order for the MCP Inspector connect to your MCP server you can either do static client registration (recommended) or Dynamic Client Registration (DCR). Pick your preferred method below and follow the instructions.
37+
In order for the MCP Inspector to connect to your MCP server you can either do static client registration (recommended) or Dynamic Client Registration (DCR). Pick your preferred method below and follow the instructions.
3838

3939
<StaticClientRegOrDCR />
4040

4141
3. Click **Connect**.
4242

4343
You'll be redirected to a login and consent screen. Sign in with a user account that has been granted the necessary permissions for the tools.
4444

45-
When you connect to the server for the first time you will be guided through the authentication process using the [Auth0 Universal Login](https://auth0.com/features/universal-login). Youll see the consent screen where you can check the tools you have access:
45+
When you connect to the server for the first time, you will be guided through the authentication process using the [Auth0 Universal Login](https://auth0.com/features/universal-login). You'll see the consent screen where you can check the tools you have access to:
4646

4747
<Frame>
4848
<img
@@ -68,7 +68,7 @@ After authenticating, you can run the tools the MCP server exposes for your user
6868
<Frame caption="List of tools available in the MCP Server">
6969
<img
7070
src="/img/mcp/tools_list_tool_administrator_role.png"
71-
alt="List of tools for an user with the Tool Administrator role"
71+
alt="List of tools for a user with the Tool Administrator role"
7272
/>
7373
</Frame>
7474

@@ -99,7 +99,7 @@ If you run into problems, here are a few things to check first:
9999

100100
* This usually means the user you logged in with doesn't have the required roles or permissions.
101101
* Check your authentication provider to ensure the user has been assigned the correct roles (e.g., "Tool User" or "Tool Administrator").
102-
* Confirm that the scopes defined in your server's oauth configuration match the permissions required by the tools.
102+
* Confirm that the scopes defined in your server's OAuth configuration match the permissions required by the tools.
103103

104104
## Conclusion
105105

auth4genai/mcp/intro/overview.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,20 @@ Register MCP clients and servers using standards-aligned discovery and registrat
5252
horizontal
5353
iconType="solid" />
5454

55-
### Call your APIs on users behalf
55+
### Call your APIs on a user's behalf
5656

5757
When an **AI agent** connects to your **MCP server**, the server may need to call your internal APIs to read data or trigger workflows. Those APIs need tokens that reflect who the user is and what the server is allowed to do.
5858

5959
**Auth0 Custom Token Exchange** enables that delegation. The MCP server exchanges the token it received from the client for a new, short-lived access token scoped to the internal API. This lets **MCP servers** call internal APIs on behalf of users while **Auth0** issues and governs access centrally.
6060

6161
<Card
62-
title="Use this quickstart to call your APIs on user's behalf from your MCP server"
62+
title="Use this quickstart to call your APIs on a user's behalf from your MCP server"
6363
href="/mcp/get-started/call-your-apis-on-users-behalf"
6464
icon="book"
6565
horizontal
6666
iconType="solid" />
6767

68-
### Call third-party APIs on users behalf
68+
### Call third-party APIs on a user's behalf
6969

7070
MCP Servers often connect AI Agents to third-party services such as Google, Microsoft, Jira, or Notion. Auth0’s **Token Vault** handles these integrations by managing token issuance, storage, rotation, and revocation for external APIs. Token Vault eliminates manual credential handling and makes it easy to extend MCP connectivity across the modern SaaS ecosystem.
7171

@@ -85,7 +85,7 @@ To begin using Auth for MCP in your MCP server, refer to the following resources
8585
/>
8686

8787
<Card
88-
title="Call your APIs on User's Behalf"
88+
title="Call your APIs on a User's Behalf"
8989
href="/mcp/get-started/call-your-apis-on-users-behalf"
9090
icon="shapes"
9191
horizontal
@@ -110,7 +110,7 @@ To begin using Auth for MCP in your MCP server, refer to the following resources
110110
/>
111111

112112
<Card
113-
title="Test you MCP Server with MCP Inspector"
113+
title="Test your MCP Server with MCP Inspector"
114114
href="/mcp/guides/test-your-mcp-server-with-mcp-inspector"
115115
icon="book"
116116
horizontal
@@ -183,5 +183,5 @@ Auth for MCP delivers a more secure and scalable authentication and authorizatio
183183
cta="Request to join the Early Access Program"
184184
vertical>
185185

186-
Auth for MCP is currently available in Early Access. To join the Early Access program, please complete this form and we'll reach out to you when your request is processed.
186+
Auth for MCP is currently available in Early Access. To join the Early Access program, please complete this form, and we'll reach out to you when your request is processed.
187187
</Card>

0 commit comments

Comments
 (0)