Skip to content

Commit f9d0cb5

Browse files
committed
Documentation
1 parent 4f0832d commit f9d0cb5

2 files changed

Lines changed: 3 additions & 7 deletions

File tree

example/mcp/readme.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This example demonstrates using TypeBox to infer to MCP protocol types directly from the core protocol definitions. The implementation is an advanced usage of TypeBox's Json Schema inference infrastructure and shows that high-fidelity types can be derived directly from schematics without requiring to code generation or explicit TS type duplication.
44

5-
[Example Reference Link](https://tsplay.dev/WKYeyN)
6-
75
## Specifications
86

97
- https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/schema/2024-11-05/schema.json

readme.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ License: MIT
7070
7171
## Type
7272
73-
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/type/overview) | [Example](https://tsplay.dev/NaMoBN)
73+
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/type/overview)
7474
7575
TypeBox provides many functions to create JSON Schema types. Each function returns a small JSON Schema fragment that can be composed into more complex types. TypeBox includes a set of functions that are used to construct JSON Schema compliant schematics as well as a set of extended functions that return schematics for constructs native to JavaScript.
7676
@@ -117,7 +117,7 @@ const S = Type.Number({ // const S = {
117117

118118
## Value
119119

120-
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/value/overview) | [Example](https://tsplay.dev/W4YE1w)
120+
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/value/overview)
121121

122122
The Value submodule provides functions for validation and other typed operations on JavaScript values. It includes functions such as Check, Parse, Clone, Encode, and Decode, as well as advanced functions for performing structural Diff and Patch operations on dynamic JavaScript values.
123123

@@ -145,7 +145,7 @@ const A = Value.Parse(T, { // const A: {
145145

146146
## Script
147147

148-
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://tsplay.dev/N9rQ8m) | [Example 2](https://tsplay.dev/NnrJoN)
148+
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview)
149149

150150
TypeBox includes a runtime TypeScript DSL engine that can transform TypeScript syntax into JSON Schema. The engine is implemented at runtime and within the TypeScript type system.
151151

@@ -231,8 +231,6 @@ If upgrading from `@sinclair/typebox` 0.34.x refer to the 1.0 migration guide at
231231

232232
Most types created with 0.34.x are compatible with V1, and it is possible to run both `typebox` and `@sinclair/typebox` packages side by side.
233233

234-
[Compatibility](https://tsplay.dev/Wzr2rW)
235-
236234
```typescript
237235
import { Type } from '@sinclair/typebox' // TB: 0.34.x
238236
import { Static } from 'typebox' // TB: 1.0.0

0 commit comments

Comments
 (0)