Skip to content

chore: Update SDK documentation - #1645

Closed
marvin-context-protocol[bot] wants to merge 1 commit into
mainfrom
marvin/update-sdk-docs
Closed

chore: Update SDK documentation#1645
marvin-context-protocol[bot] wants to merge 1 commit into
mainfrom
marvin/update-sdk-docs

chore: Update SDK documentation

6a29942
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (fastmcp) - vale-spellcheck completed Aug 30, 2025 in 3s

Mintlify Validation (fastmcp) - vale-spellcheck Failed

Found 100 suggested changes across 14 files in 467.55ms

Details

Running Vale across on the following files affected by this PR:

- python-sdk/fastmcp-cli-cli.mdx
- python-sdk/fastmcp-cli-install-claude_code.mdx
- python-sdk/fastmcp-cli-install-claude_desktop.mdx
- python-sdk/fastmcp-cli-install-cursor.mdx
- python-sdk/fastmcp-cli-install-mcp_json.mdx
- python-sdk/fastmcp-cli-run.mdx
- python-sdk/fastmcp-client-auth-oauth.mdx
- python-sdk/fastmcp-client-client.mdx
- python-sdk/fastmcp-server-auth-oauth_proxy.mdx
- python-sdk/fastmcp-server-auth-providers-workos.mdx
- python-sdk/fastmcp-server-auth-redirect_validation.mdx
- python-sdk/fastmcp-server-middleware-logging.mdx
- python-sdk/fastmcp-utilities-cli.mdx
- python-sdk/fastmcp-utilities-fastmcp_config-v1-fastmcp_config.mdx

Attempting to initialize Vale linter...
No customer vale configuration detected. Using Mintlify's default configuration.
Attempting to run Vale spellcheck...
Vale spellcheck completed successfully.

docs/python-sdk/fastmcp-cli-cli.mdx:
	- 9:25      Did you really mean 'Cyclopts'?
	- 63:90     Did you really mean 'mcp'?
	- 66:4      Did you really mean 'MCPConfig'?
	- 66:83     Did you really mean 'MCPConfig'?
	- 71:1      Did you really mean 'fastmcp'?
	- 92:1      Did you really mean 'fastmcp'?
	- 95:1      Did you really mean 'fastmcp'?
	- 95:36     Did you really mean 'fastmcp'?
	- 98:1      Did you really mean 'fastmcp'?
	- 98:36     Did you really mean 'mcp'?
	- 101:1     Did you really mean 'fastmcp'?
	- 101:17    Did you really mean 'fastmcp'?
	- 115:52    Did you really mean 'uv'?
	- 117:35    Did you really mean 'uv'?
	- 123:1     Did you really mean 'fastmcp'?

docs/python-sdk/fastmcp-cli-install-claude_code.mdx:
	- 3:15     Did you really mean 'claude_code'?
	- 9:51     Did you really mean 'Cyclopts'?
	- 22:45    Did you really mean 'claude'?
	- 23:24    Did you really mean 'subprocess'?

docs/python-sdk/fastmcp-cli-install-claude_desktop.mdx:
	- 3:15    Did you really mean 'claude_desktop'?
	- 9:54    Did you really mean 'Cyclopts'?

docs/python-sdk/fastmcp-cli-install-cursor.mdx:
	- 9:46     Did you really mean 'Cyclopts'?
	- 20:19    Did you really mean 'deeplink'?
	- 27:3     Did you really mean 'Deeplink'?
	- 37:19    Did you really mean 'deeplink'?
	- 40:19    Did you really mean 'deeplink'?

docs/python-sdk/fastmcp-cli-install-mcp_json.mdx:
	- 3:15    Did you really mean 'mcp_json'?
	- 9:61    Did you really mean 'Cyclopts'?

docs/python-sdk/fastmcp-cli-run.mdx:
	- 30:24    Did you really mean 'uv'?
	- 30:31    Did you really mean 'subprocess'?
	- 74:32    Did you really mean 'MCPConfig'?

docs/python-sdk/fastmcp-client-auth-oauth.mdx:
	- 146:35    Did you really mean 'auth_code'?

docs/python-sdk/fastmcp-client-client.mdx:
	- 28:22     Did you really mean 'reentrant'?
	- 36:36     Did you really mean 'reentrant'?
	- 54:7      Did you really mean 'MCPConfig'?
	- 61:56     Did you really mean 'timedelta'?
	- 62:71     Did you really mean 'timedelta'?
	- 452:70    Did you really mean 'isError'?
	- 477:8     Did you really mean 'call_tool_mcp'?
	- 488:33    Did you really mean 'dataclass'?
	- 491:27    Did you really mean 'call_tool_mcp'?

docs/python-sdk/fastmcp-server-auth-oauth_proxy.mdx:
	- 3:15      Did you really mean 'oauth_proxy'?
	- 41:34     Did you really mean 'URIs'?
	- 47:31     Did you really mean 'URIs'?
	- 54:41     Did you really mean 'URIs'?
	- 68:28     Did you really mean 'URIs'?
	- 76:62     Did you really mean 'proxying'?
	- 76:82     Did you really mean 'IDPs'?
	- 82:17     Did you really mean 'IDPs'?
	- 88:3      Did you really mean 'Proxying'?
	- 102:15    Did you really mean 'IDPs'?
	- 105:21    Did you really mean 'URIs'?
	- 107:15    Did you really mean 'IDPs'?
	- 107:59    Did you really mean 'URIs'?
	- 112:50    Did you really mean 'URIs'?
	- 129:57    Did you really mean 'URIs'?
	- 148:49    Did you really mean 'authlib'?
	- 155:4     Did you really mean '_clients'?
	- 156:4     Did you really mean '_oauth_transactions'?
	- 157:4     Did you really mean '_client_codes'?
	- 158:4     Did you really mean '_access_tokens'?
	- 158:20    Did you really mean '_refresh_tokens'?
	- 210:46    Did you really mean 'client_id'?
	- 210:60    Did you really mean 'client_secret'?
	- 211:57    Did you really mean 'client_info'?
	- 218:45    Did you really mean 'client_info'?
	- 219:58    Did you really mean 'URIs'?
	- 223:41    Did you really mean 'URIs'?
	- 282:51    Did you really mean 'authlib'?

docs/python-sdk/fastmcp-server-auth-providers-workos.mdx:
	- 3:15     Did you really mean 'workos'?
	- 44:38    Did you really mean 'userinfo'?
	- 57:34    Did you really mean 'userinfo'?
	- 59:38    Did you really mean 'openid'?
	- 76:18    Did you really mean 'proxying'?

docs/python-sdk/fastmcp-server-auth-redirect_validation.mdx:
	- 3:15     Did you really mean 'redirect_validation'?
	- 9:42     Did you really mean 'URIs'?
	- 47:62    Did you really mean 'URIs'?
	- 48:32    Did you really mean 'URIs'?

docs/python-sdk/fastmcp-server-middleware-logging.mdx:
	- 20:13    Did you really mean 'serializer'?
	- 51:35    Did you really mean 'Splunk'?

docs/python-sdk/fastmcp-utilities-cli.mdx:
	- 17:45    Did you really mean 'uv'?
	- 17:48    Did you really mean 'subprocess'?
	- 27:18    Did you really mean 'server_spec'?
	- 37:28    Did you really mean 'resolved_server_spec'?

docs/python-sdk/fastmcp-utilities-fastmcp_config-v1-fastmcp_config.mdx:
	- 3:15      Did you really mean 'fastmcp_config'?
	- 36:34     Did you really mean 'output_path'?
	- 55:16     Did you really mean 'uv'?
	- 58:42     Did you really mean 'fastmcp'?
	- 61:57     Did you really mean 'uv'?
	- 70:25     Did you really mean 'uv'?
	- 73:56     Did you really mean 'fastmcp'?
	- 82:43     Did you really mean 'uv'?
	- 85:44     Did you really mean 'uv'?
	- 94:38     Did you really mean 'uv'?
	- 97:48     Did you really mean 'uv'?
	- 252:6     Did you really mean 'output_dir'?
	- 252:51    Did you really mean 'uv'?
	- 253:6     Did you really mean 'output_dir'?
	- 257:52    Did you really mean 'uv'?
	- 270:32    Did you really mean 'uv'?


Found 100 suggested changes across 14 files in 467.55ms

Annotations

Check warning on line 9 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L9

Did you really mean 'Cyclopts'?

Check warning on line 63 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L63

Did you really mean 'mcp'?

Check warning on line 66 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L66

Did you really mean 'MCPConfig'?

Check warning on line 66 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L66

Did you really mean 'MCPConfig'?

Check warning on line 71 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L71

Did you really mean 'fastmcp'?

Check warning on line 92 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L92

Did you really mean 'fastmcp'?

Check warning on line 95 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L95

Did you really mean 'fastmcp'?

Check warning on line 95 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L95

Did you really mean 'fastmcp'?

Check warning on line 98 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L98

Did you really mean 'fastmcp'?

Check warning on line 98 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L98

Did you really mean 'mcp'?

Check warning on line 101 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L101

Did you really mean 'fastmcp'?

Check warning on line 101 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L101

Did you really mean 'fastmcp'?

Check warning on line 115 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L115

Did you really mean 'uv'?

Check warning on line 117 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L117

Did you really mean 'uv'?

Check warning on line 123 in python-sdk/fastmcp-cli-cli.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-cli.mdx#L123

Did you really mean 'fastmcp'?

Check warning on line 3 in python-sdk/fastmcp-cli-install-claude_code.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_code.mdx#L3

Did you really mean 'claude_code'?

Check warning on line 9 in python-sdk/fastmcp-cli-install-claude_code.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_code.mdx#L9

Did you really mean 'Cyclopts'?

Check warning on line 22 in python-sdk/fastmcp-cli-install-claude_code.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_code.mdx#L22

Did you really mean 'claude'?

Check warning on line 23 in python-sdk/fastmcp-cli-install-claude_code.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_code.mdx#L23

Did you really mean 'subprocess'?

Check warning on line 3 in python-sdk/fastmcp-cli-install-claude_desktop.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_desktop.mdx#L3

Did you really mean 'claude_desktop'?

Check warning on line 9 in python-sdk/fastmcp-cli-install-claude_desktop.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-claude_desktop.mdx#L9

Did you really mean 'Cyclopts'?

Check warning on line 9 in python-sdk/fastmcp-cli-install-cursor.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-cursor.mdx#L9

Did you really mean 'Cyclopts'?

Check warning on line 20 in python-sdk/fastmcp-cli-install-cursor.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-cursor.mdx#L20

Did you really mean 'deeplink'?

Check warning on line 27 in python-sdk/fastmcp-cli-install-cursor.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-cursor.mdx#L27

Did you really mean 'Deeplink'?

Check warning on line 37 in python-sdk/fastmcp-cli-install-cursor.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (fastmcp) - vale-spellcheck

python-sdk/fastmcp-cli-install-cursor.mdx#L37

Did you really mean 'deeplink'?