Skip to content

Commit b3c5a85

Browse files
fix: resolve CI failures and Vale linting errors
- Remove empty fern/apis/fern-docs-mcp directory causing CI failure - Change 'API reference' to 'API Reference' per FernStyles.Reject rule - Use contractions (isn't, doesn't) per Microsoft.Contractions - Define SSO (Single sign-on) on first use per FernStyles.Acronyms - Fix broken link in api-get-started.mdx to use correct path - Remove download link to openapi.yaml (file not hosted) Co-Authored-By: [email protected] <[email protected]>
1 parent cf33cb2 commit b3c5a85

File tree

3 files changed

+10
-161
lines changed

3 files changed

+10
-161
lines changed

fern/apis/fern-docs-mcp/openapi.yaml

Lines changed: 0 additions & 149 deletions
This file was deleted.

fern/products/ask-fern/pages/features/mcp-server.mdx

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Model Context Protocol (MCP) server endpoints allow AI agents and automated
1313
- **Automated testing**: Programmatically verify documentation content and search functionality
1414
- **Custom integrations**: Build tools that need to access protected documentation content
1515

16-
## API reference
16+
## API Reference
1717

1818
### Exchange an API key for a JWT
1919

@@ -51,12 +51,12 @@ GET /api/fern-docs/get-jwt
5151

5252
| Status | Description |
5353
|--------|-------------|
54-
| 400 | JWT generation is not accessible in local preview mode |
55-
| 400 | JWT generation is not supported in self-hosted environments |
56-
| 400 | SSO/WorkOS authentication is not supported by this endpoint |
54+
| 400 | JWT generation isn't accessible in local preview mode |
55+
| 400 | JWT generation isn't supported in self-hosted environments |
56+
| 400 | Single sign-on (SSO)/WorkOS authentication isn't supported by this endpoint |
5757
| 401 | Missing `FERN_API_KEY` header |
5858
| 401 | Invalid API key |
59-
| 403 | API key does not belong to the organization that owns this domain |
59+
| 403 | API key doesn't belong to the organization that owns this domain |
6060
| 500 | Authentication configuration error or JWT generation failed |
6161

6262
#### Example
@@ -134,10 +134,10 @@ Alternatively, the `FERN_TOKEN` can be provided as a cookie instead of a header.
134134

135135
| Status | Description |
136136
|--------|-------------|
137-
| 400 | Search key is not accessible in local preview mode |
138-
| 400 | Search is not supported for preview URLs (unless explicitly enabled) |
137+
| 400 | Search key isn't accessible in local preview mode |
138+
| 400 | Search isn't supported for preview URLs (unless explicitly enabled) |
139139
| 401 | Invalid API key |
140-
| 403 | API key does not belong to the organization that owns this domain |
140+
| 403 | API key doesn't belong to the organization that owns this domain |
141141

142142
#### Example with API key
143143

@@ -170,7 +170,7 @@ curl -X GET https://docs.example.com/api/fern-docs/search/v2/key \
170170

171171
## OpenAPI specification
172172

173-
Download the complete OpenAPI specification for these endpoints:
173+
The complete OpenAPI specification for these endpoints:
174174

175175
```yaml
176176
openapi: 3.1.0
@@ -323,5 +323,3 @@ paths:
323323
'403':
324324
description: Forbidden (API key does not belong to organization)
325325
```
326-
327-
You can also download this specification as a file: [openapi.yaml](/apis/fern-docs-mcp/openapi.yaml)

fern/products/ask-fern/pages/getting-started/api-get-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ The Fern AI API allows you to manage your Ask Fern configuration using Fern's pu
1515

1616
Fern API requests require a bearer token for authentication. Use the CLI command [`fern token`](/learn/cli-api/cli-reference/commands#fern-token) to generate a bearer token. Tokens do not expire.
1717

18-
For MCP agents and automated tools that need to authenticate and search your documentation, see the [MCP server documentation](/learn/ask-fern/mcp-server).
18+
For MCP agents and automated tools that need to authenticate and search your documentation, see the [MCP server documentation](/learn/ask-fern/features/mcp-server).

0 commit comments

Comments
 (0)