feat: updated the docs

Author: MathurAditya724

CODE_OF_CONDUCT.md

@@ -0,0 +1,113 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**<[email protected]>**.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks for showing interest in contributing to Muppet 💖, you rock!
+
+When it comes to open source, you can contribute in different ways, all of which are valuable.

docs/astro.config.mjs

@@ -49,11 +49,8 @@ export default defineConfig({
           ],
         },
         {
-          label: "Tutorials",
-          items: [
-            { label: "Debugging", slug: "tutorials/debugging" },
-            { label: "Inspector", slug: "tutorials/inspector" },
-          ],
+          label: "Tools",
+          items: [{ label: "Inspector", slug: "tools/inspector" }],
         },
         {
           label: "Concepts",
@@ -62,6 +59,7 @@ export default defineConfig({
             { label: "Resources", slug: "concepts/resources" },
             { label: "Prompts", slug: "concepts/prompts" },
             { label: "Tools", slug: "concepts/tools" },
+            { label: "Transports", slug: "concepts/transports" },
           ],
         },
         {

docs/package.json

@@ -13,5 +13,11 @@
     "@astrojs/starlight": "^0.32.3",
     "astro": "^5.1.5",
     "sharp": "^0.32.5"
+  },
+  "devDependencies": {
+    "@modelcontextprotocol/sdk": "^1.7.0",
+    "hono": "^4.7.5",
+    "muppet": "workspace:*",
+    "zod": "^3.24.2"
   }
 }

docs/src/assets/logo-dark.png

@@ -0,0 +1,50 @@
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { Hono } from "hono";
+import {
+  describePrompt,
+  mValidator,
+  muppet,
+  type PromptResponseType,
+} from "muppet";
+import z from "zod";
+
+const app = new Hono();
+
+// Define a simple prompt
+app.post(
+  "/simple",
+  describePrompt({ name: "Simple Prompt" }),
+  mValidator(
+    z.object({
+      name: z.string(),
+    }),
+  ),
+  (c) => {
+    const { name } = c.req.valid("json");
+    return c.json<PromptResponseType>([
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: `This is a simple prompt for ${name}`,
+        },
+      },
+    ]);
+  },
+);
+
+// Creating your mcp server
+muppet(app, {
+  name: "My Muppet",
+  version: "1.0.0",
+}).then((mcp) => {
+  if (!mcp) {
+    throw new Error("MCP not initialized");
+  }
+
+  // Connecting your mcp to a transport
+  bridge({
+    mcp,
+    transport: new StdioServerTransport(),
+  });
+});

docs/src/assets/logo-light.png

@@ -0,0 +1,41 @@
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { Hono } from "hono";
+import { muppet, registerResources } from "muppet";
+
+const app = new Hono();
+
+// Define all the resources that your tool can provide
+app.post(
+  "/documents",
+  registerResources((c) => {
+    return c.json([
+      {
+        uri: "https://lorem.ipsum",
+        name: "Todo list",
+        mimeType: "text/plain",
+      },
+      {
+        type: "template",
+        uri: "https://lorem.{ending}",
+        name: "Todo list",
+        mimeType: "text/plain",
+      },
+    ]);
+  }),
+);
+
+// Creating your mcp server
+muppet(app, {
+  name: "My Muppet",
+  version: "1.0.0",
+}).then((mcp) => {
+  if (!mcp) {
+    throw new Error("MCP not initialized");
+  }
+
+  // Connecting your mcp to a transport
+  bridge({
+    mcp,
+    transport: new StdioServerTransport(),
+  });
+});

docs/src/content/docs/concepts/example-prompt.ts

@@ -0,0 +1,52 @@
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { Hono } from "hono";
+import {
+  describeTool,
+  mValidator,
+  muppet,
+  type ToolResponseType,
+} from "muppet";
+import z from "zod";
+
+const app = new Hono();
+
+// Define a simple hello world tool
+app.post(
+  "/hello",
+  describeTool({
+    name: "Hello World",
+    description: "A simple hello world route",
+  }),
+  mValidator(
+    // You can use your favorite schema validator,
+    // eg - zod, valibot, arktype, typebox, etc
+    z.object({
+      name: z.string(),
+    }),
+  ),
+  (c) => {
+    const { name } = c.req.valid("json");
+    return c.json<ToolResponseType>([
+      {
+        type: "text",
+        text: `Hello ${name}!`,
+      },
+    ]);
+  },
+);
+
+// Creating your mcp server
+muppet(app, {
+  name: "My Muppet",
+  version: "1.0.0",
+}).then((mcp) => {
+  if (!mcp) {
+    throw new Error("MCP not initialized");
+  }
+
+  // Connecting your mcp to a transport
+  bridge({
+    mcp,
+    transport: new StdioServerTransport(),
+  });
+});