Merge pull request modelcontextprotocol#921 from jonathanhefner/add-schema-reference-page

Add schema reference page

Author: jonathanhefner

.gitattributes

@@ -1,2 +1,4 @@
 package-lock.json linguist-generated=true
 schema/*/schema.json linguist-generated=true
+docs/specification/*/schema.md linguist-generated=true
+docs/specification/*/schema.mdx linguist-generated=true

.github/workflows/main.yml

@@ -21,5 +21,8 @@ jobs:
       - name: Check TypeScript definitions
         run: npm run check:schema:ts
 
-      - name: Verify that `npm run generate:json` did not change outputs (if it did, please re-run it and re-commit!)
+      - name: Check schema.json files are up to date
         run: npm run check:schema:json
+
+      - name: Check schema.mdx files are up to date
+        run: npm run check:schema:md

.prettierignore

@@ -0,0 +1,2 @@
+docs/specification/*/schema.md
+docs/specification/*/schema.mdx

CONTRIBUTING.md

@@ -47,7 +47,7 @@ git checkout -b feature/your-feature-name
 
 ```bash
 npm run check:schema:ts
-npm run generate:json
+npm run generate:schema
 ```
 
 4. Validate documentation changes and apply formatting:

docs/docs.json

@@ -473,7 +473,8 @@
                     ]
                   }
                 ]
-              }
+              },
+              "specification/draft/schema"
             ]
           },
           {

docs/specification/draft/schema.mdx

@@ -1,4 +1,6 @@
 #content-area {
+  --font-mono: var(--font-jetbrains-mono), ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; /* via Mintlify theme */
+
   h5 {
     font-weight: 500;
   }
@@ -16,6 +18,7 @@
   min-width: 800px;
 }
 
+
 /*** Add automatic section numbers to headings and table of contents items ***/
 
 #enable-section-numbers {
@@ -84,3 +87,107 @@ body:has(#enable-section-numbers) {
       "." counter(h5-counter) "." counter(h6-counter) " ";
   }
 }
+
+
+/*** Page: schema reference ***/
+
+#schema-reference {
+  display: none;
+}
+
+body:has(#schema-reference) {
+  .tsd-comment {
+    :is(p, ul, ol):first-child {
+      margin-top: 0;
+    }
+
+    :is(p, ul, ol):last-child {
+      margin-bottom: 0;
+    }
+  }
+
+  .tsd-signature {
+    font-family: var(--font-mono);
+    font-size: 0.875rem;
+    line-height: 1.5rem;
+
+    /* Based on code blocks rendered by Mintlify **on the production site**. */
+    margin: 1.25rem 0;
+    border: 1px solid;
+    border-color: light-dark(rgb(var(--gray-950)/.1), rgba(255, 255, 255, 0.1));
+    border-radius: 1rem;
+    padding: 1rem 0.875rem;
+
+    a {
+      font-weight: normal;
+      border-bottom: none;
+      text-decoration: underline;
+
+      &:hover {
+        text-decoration-thickness: 2px;
+      }
+    }
+
+    a[href="#"] {
+      pointer-events: none;
+      color: inherit;
+      text-decoration: none;
+    }
+
+    .tsd-signature-keyword {
+      color: light-dark(rgb(207, 34, 46), #9CDCFE);
+    }
+
+    :is(.tsd-kind-interface, .tsd-kind-type-alias):not(.tsd-signature-type) {
+      color: light-dark(rgb(149, 56, 0), #4EC9B0);
+    }
+
+    .tsd-signature-type:not(.tsd-kind-interface, .tsd-kind-type-alias) {
+      color: light-dark(rgb(5, 80, 174), #DCDCAA);
+    }
+  }
+
+  .tsd-member {
+    margin: 1.25rem 0;
+
+    [data-typedoc-h="3"] {
+      margin: 0.5rem 0;
+
+      font-family: var(--font-mono);
+      font-weight: 700;
+
+      scroll-margin-top: 5rem;
+    }
+
+    & > .tsd-comment {
+      margin-left: 1.25rem;
+    }
+
+    .tsd-type-declaration {
+      [data-typedoc-h="4"] {
+        display: none;
+      }
+
+      [data-typedoc-h="4"] + ul {
+        margin-top: 0;
+      }
+
+      [data-typedoc-h="5"] {
+        font-family: var(--font-mono);
+        font-size: 0.875rem;
+        font-weight: 500;
+
+        width: fit-content;
+        padding: 0.125em 0.5em;
+        background-color: light-dark(rgb(var(--gray-100)/.5), rgb(255 255 255/.05));
+      }
+    }
+
+    .tsd-anchor-icon,
+    .tsd-tag,
+    .tsd-signature,
+    .tsd-sources {
+      display: none;
+    }
+  }
+}