mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
149a7aa2ce* docs: align CLI and deployment docs Generated with Codex. * docs: restore install config support, fix CIMD placeholder, add missing CLI flags * docs: restore contrib guidance, correct --copy availability * docs: remove dead redirect-shadowed pages * Fix stale --path default in run command help * docs: correct Goose flag support, fix README link to moved testing page --------- Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com>
89 lines
2.8 KiB
Text
89 lines
2.8 KiB
Text
---
|
|
title: Auth Utilities
|
|
sidebarTitle: Auth
|
|
description: Create and validate CIMD documents for OAuth
|
|
icon: key
|
|
---
|
|
|
|
import { VersionBadge } from '/snippets/version-badge.mdx'
|
|
|
|
<VersionBadge version="3.0.0" />
|
|
|
|
The `fastmcp auth` commands help with CIMD (Client ID Metadata Document) management — part of MCP's OAuth authentication flow. A CIMD is a JSON document you host at an HTTPS URL to identify your client application to MCP servers.
|
|
|
|
## Creating a CIMD
|
|
|
|
`fastmcp auth cimd create` generates a CIMD document:
|
|
|
|
```bash
|
|
fastmcp auth cimd create \
|
|
--name "My App" \
|
|
--redirect-uri "http://localhost:*/callback"
|
|
```
|
|
|
|
```json
|
|
{
|
|
"client_id": "https://YOUR-DOMAIN.com/path/to/client.json",
|
|
"client_name": "My App",
|
|
"redirect_uris": ["http://localhost:*/callback"],
|
|
"token_endpoint_auth_method": "none",
|
|
"grant_types": ["authorization_code"],
|
|
"response_types": ["code"]
|
|
}
|
|
```
|
|
|
|
By default, the generated document includes a placeholder `client_id`. Update it to match the URL where you'll host the document before deploying, or pass `--client-id` when generating the file.
|
|
|
|
### Options
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| Name | `--name` | **Required.** Human-readable client name |
|
|
| Redirect URI | `--redirect-uri`, `-r` | **Required.** Allowed redirect URIs (repeatable) |
|
|
| Client ID | `--client-id` | URL where this document will be hosted; defaults to a placeholder |
|
|
| Client URI | `--client-uri` | Client's home page URL |
|
|
| Logo URI | `--logo-uri` | Client's logo URL |
|
|
| Scope | `--scope` | Space-separated list of scopes |
|
|
| Output | `--output`, `-o` | Save to file (default: stdout) |
|
|
| Pretty | `--pretty` | Pretty-print JSON (default: true) |
|
|
|
|
### Example
|
|
|
|
```bash
|
|
fastmcp auth cimd create \
|
|
--name "My Production App" \
|
|
--redirect-uri "http://localhost:*/callback" \
|
|
--redirect-uri "https://myapp.example.com/callback" \
|
|
--client-id "https://myapp.example.com/oauth/client.json" \
|
|
--client-uri "https://myapp.example.com" \
|
|
--scope "read write" \
|
|
--output client.json
|
|
```
|
|
|
|
## Validating a CIMD
|
|
|
|
`fastmcp auth cimd validate` fetches a hosted CIMD and verifies it conforms to the spec:
|
|
|
|
```bash
|
|
fastmcp auth cimd validate https://myapp.example.com/oauth/client.json
|
|
```
|
|
|
|
The validator checks that the URL is valid (HTTPS, non-root path), the document is valid JSON, the `client_id` matches the URL, and no shared-secret auth methods are used.
|
|
|
|
On success:
|
|
|
|
```
|
|
→ Fetching https://myapp.example.com/oauth/client.json...
|
|
✓ Valid CIMD document
|
|
|
|
Document details:
|
|
client_id: https://myapp.example.com/oauth/client.json
|
|
client_name: My App
|
|
token_endpoint_auth_method: none
|
|
redirect_uris:
|
|
• http://localhost:*/callback
|
|
```
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| Timeout | `--timeout`, `-t` | HTTP request timeout in seconds (default: 10) |
|