Skip to content

docs(sdk): guide agents to match uppercase title conventions

c5a322f
Select commit
Loading
Failed to load commit list.
Merged

feat(sdk): optimize tool definitions and prompts for efficient MCP workflows #2722

docs(sdk): guide agents to match uppercase title conventions
c5a322f
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck completed Apr 6, 2026 in 4s

Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck Failed

Found 91 suggested changes across 4 files in 1810.98ms

Details

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

- ai/agents/best-practices.mdx
- ai/mcp/how-to-use.mdx
- document-api/reference/mutations/apply.mdx
- document-api/reference/mutations/preview.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.

apps/docs/ai/agents/best-practices.mdx:
	- 5:12     Did you really mean 'llm'?
	- 5:73     Did you really mean 'superdoc'?
	- 113:7    Did you really mean 'hardcode'?

apps/docs/ai/mcp/how-to-use.mdx:
	- 5:12       Did you really mean 'mcp'?
	- 5:17       Did you really mean 'superdoc'?
	- 105:80     Did you really mean 'substring'?
	- 144:64     Did you really mean 'API's'?
	- 156:103    Did you really mean 'nodeIds'?

apps/docs/document-api/reference/mutations/apply.mdx:
	- 115:4      Did you really mean 'changeMode'?
	- 116:4      Did you really mean 'expectedRevision'?
	- 131:14     Did you really mean 'requireUniform'?
	- 152:12     Did you really mean 'nodeType'?
	- 186:6      Did you really mean 'totalMs'?
	- 237:6      Did you really mean 'changeMode'?
	- 327:28     Did you really mean 'setMarks'?
	- 460:32     Did you really mean 'nodeType'?
	- 596:28     Did you really mean 'setMarks'?
	- 710:28     Did you really mean 'nodeType'?
	- 845:32     Did you really mean 'nodeType'?
	- 1010:32    Did you really mean 'sz'?
	- 1049:24    Did you really mean 'charScale'?
	- 1070:24    Did you really mean 'contextualAlternates'?
	- 1090:24    Did you really mean 'dstrike'?
	- 1116:32    Did you really mean 'combineBrackets'?
	- 1148:32    Did you really mean 'vertCompress'?
	- 1187:24    Did you really mean 'fitText'?
	- 1222:24    Did you really mean 'fontFamily'?
	- 1233:24    Did you really mean 'fontSize'?
	- 1264:24    Did you really mean 'iCs'?
	- 1321:32    Did you really mean 'eastAsia'?
	- 1351:24    Did you really mean 'letterSpacing'?
	- 1372:24    Did you really mean 'numForm'?
	- 1383:24    Did you really mean 'numSpacing'?
	- 1394:24    Did you really mean 'oMath'?
	- 1424:24    Did you really mean 'rFonts'?
	- 1441:32    Did you really mean 'asciiTheme'?
	- 1463:32    Did you really mean 'csTheme'?
	- 1496:32    Did you really mean 'hAnsi'?
	- 1537:24    Did you really mean 'rStyle'?
	- 1548:24    Did you really mean 'rtl'?
	- 1615:24    Did you really mean 'smallCaps'?
	- 1635:24    Did you really mean 'specVanish'?
	- 1655:24    Did you really mean 'stylisticSets'?
	- 1673:30    Did you really mean 'minItems'?
	- 1715:32    Did you really mean 'themeColor'?
	- 1741:24    Did you really mean 'vertAlign'?
	- 1755:24    Did you really mean 'webHidden'?
	- 1843:32    Did you really mean 'nodeType'?
	- 1947:20    Did you really mean 'expectCount'?
	- 2126:6     Did you really mean 'trackedChanges'?

apps/docs/document-api/reference/mutations/preview.mdx:
	- 115:4      Did you really mean 'changeMode'?
	- 116:4      Did you really mean 'expectedRevision'?
	- 131:14     Did you really mean 'requireUniform'?
	- 152:12     Did you really mean 'nodeType'?
	- 173:4      Did you really mean 'evaluatedRevision'?
	- 223:6      Did you really mean 'changeMode'?
	- 313:28     Did you really mean 'setMarks'?
	- 446:32     Did you really mean 'nodeType'?
	- 582:28     Did you really mean 'setMarks'?
	- 696:28     Did you really mean 'nodeType'?
	- 831:32     Did you really mean 'nodeType'?
	- 996:32     Did you really mean 'sz'?
	- 1035:24    Did you really mean 'charScale'?
	- 1056:24    Did you really mean 'contextualAlternates'?
	- 1076:24    Did you really mean 'dstrike'?
	- 1102:32    Did you really mean 'combineBrackets'?
	- 1134:32    Did you really mean 'vertCompress'?
	- 1173:24    Did you really mean 'fitText'?
	- 1208:24    Did you really mean 'fontFamily'?
	- 1219:24    Did you really mean 'fontSize'?
	- 1250:24    Did you really mean 'iCs'?
	- 1307:32    Did you really mean 'eastAsia'?
	- 1337:24    Did you really mean 'letterSpacing'?
	- 1358:24    Did you really mean 'numForm'?
	- 1369:24    Did you really mean 'numSpacing'?
	- 1380:24    Did you really mean 'oMath'?
	- 1410:24    Did you really mean 'rFonts'?
	- 1427:32    Did you really mean 'asciiTheme'?
	- 1449:32    Did you really mean 'csTheme'?
	- 1482:32    Did you really mean 'hAnsi'?
	- 1523:24    Did you really mean 'rStyle'?
	- 1534:24    Did you really mean 'rtl'?
	- 1601:24    Did you really mean 'smallCaps'?
	- 1621:24    Did you really mean 'specVanish'?
	- 1641:24    Did you really mean 'stylisticSets'?
	- 1659:30    Did you really mean 'minItems'?
	- 1701:32    Did you really mean 'themeColor'?
	- 1727:24    Did you really mean 'vertAlign'?
	- 1741:24    Did you really mean 'webHidden'?
	- 1829:32    Did you really mean 'nodeType'?
	- 1933:20    Did you really mean 'expectCount'?


Found 91 suggested changes across 4 files in 1810.98ms

Annotations

Check warning on line 5 in ai/agents/best-practices.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/agents/best-practices.mdx#L5

Did you really mean 'llm'?

Check warning on line 5 in ai/agents/best-practices.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/agents/best-practices.mdx#L5

Did you really mean 'superdoc'?

Check warning on line 113 in ai/agents/best-practices.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/agents/best-practices.mdx#L113

Did you really mean 'hardcode'?

Check warning on line 5 in ai/mcp/how-to-use.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/mcp/how-to-use.mdx#L5

Did you really mean 'mcp'?

Check warning on line 5 in ai/mcp/how-to-use.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/mcp/how-to-use.mdx#L5

Did you really mean 'superdoc'?

Check warning on line 105 in ai/mcp/how-to-use.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/mcp/how-to-use.mdx#L105

Did you really mean 'substring'?

Check warning on line 144 in ai/mcp/how-to-use.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/mcp/how-to-use.mdx#L144

Did you really mean 'API's'?

Check warning on line 156 in ai/mcp/how-to-use.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

ai/mcp/how-to-use.mdx#L156

Did you really mean 'nodeIds'?

Check warning on line 115 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L115

Did you really mean 'changeMode'?

Check warning on line 116 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L116

Did you really mean 'expectedRevision'?

Check warning on line 131 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L131

Did you really mean 'requireUniform'?

Check warning on line 152 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L152

Did you really mean 'nodeType'?

Check warning on line 186 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L186

Did you really mean 'totalMs'?

Check warning on line 237 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L237

Did you really mean 'changeMode'?

Check warning on line 327 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L327

Did you really mean 'setMarks'?

Check warning on line 460 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L460

Did you really mean 'nodeType'?

Check warning on line 596 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L596

Did you really mean 'setMarks'?

Check warning on line 710 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L710

Did you really mean 'nodeType'?

Check warning on line 845 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L845

Did you really mean 'nodeType'?

Check warning on line 1010 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1010

Did you really mean 'sz'?

Check warning on line 1049 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1049

Did you really mean 'charScale'?

Check warning on line 1070 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1070

Did you really mean 'contextualAlternates'?

Check warning on line 1090 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1090

Did you really mean 'dstrike'?

Check warning on line 1116 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1116

Did you really mean 'combineBrackets'?

Check warning on line 1148 in document-api/reference/mutations/apply.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (superdoc-andrii-sd-2451-refactor-mcp-set-up) - vale-spellcheck

document-api/reference/mutations/apply.mdx#L1148

Did you really mean 'vertCompress'?