xmcp 0.0.18 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  </a>
8
8
  <h1>xmcp</h1>
9
9
 
10
- <a href="https://basement.studio"><img alt="XMCP logo" src="https://img.shields.io/badge/MADE%20BY%20basement.studio-000000.svg?style=for-the-badge&labelColor=000"></a>
10
+ <a href="https://basement.studio"><img alt="xmcp logo" src="https://img.shields.io/badge/MADE%20BY%20basement.studio-000000.svg?style=for-the-badge&labelColor=000"></a>
11
11
  <a href="https://www.npmjs.com/package/xmcp"><img alt="NPM version" src="https://img.shields.io/npm/v/xmcp.svg?style=for-the-badge&labelColor=000000"></a>
12
12
  <a href="https://github.com/basementstudio/xmcp/blob/main/license.md"><img alt="License" src="https://img.shields.io/npm/l/xmcp.svg?style=for-the-badge&labelColor=000000"></a>
13
13
 
@@ -15,28 +15,35 @@
15
15
 
16
16
  ## The TypeScript MCP Framework
17
17
 
18
- Xmcp is framework for building and shipping MCP applications with TypeScript. Designed with DX in mind, it streamlines development and lowers the barrier to entry for anyone looking to create and deploy powerful tools on top of the MCP ecosystem.
19
-
20
- The framework handles complex tasks like transports, building and authentication, so developers can focus on what matters most: coding the tools, resources, or clients they want to bring to life.
18
+ `xmcp` is a framework for building and shipping MCP applications with TypeScript. Designed with DX in mind, it streamlines development and lowers the barrier to entry for anyone looking to create and deploy powerful tools on top of the Model Context Protocol ecosystem.
21
19
 
22
20
  ## Getting Started
23
21
 
24
- - Visit [xmcp.dev](https://xmcp.dev) to learn more about the project.
25
- - Visit [xmcp.dev/docs](https://xmcp.dev/docs) to view the full documentation.
22
+ Bootstrap your first `xmcp` application with:
23
+
24
+ ```bash
25
+ npx create-xmcp-app@latest
26
+ ```
27
+
28
+ or initialize `xmcp` on an existing Next.js or Express project with:
29
+
30
+ ```bash
31
+ npx init-xmcp@latest
32
+ ```
26
33
 
27
34
  ## Features
28
35
 
29
- - **Hot Reloading** - Instant development feedback with automatic rebuilds
30
- - **File system routing** - Tools are automatically discovered and registered from `src/tools` directory.
31
- - **TypeScript First** - Full TypeScript support with type inference
32
- - **Schema Validation** - Built-in parameter validation with Zod
33
- - **Rich Tooling** - Built-in CLI for development and building
34
- - **MCP Compatible** - Full compatibility with Model Context Protocol
35
- - **STDIO Transport** - Standard I/O transport for local MCP servers
36
- - **HTTP Transport** - Stramable HTTP transport for web-based MCP servers
37
- - **Middleware Support** - Extensible middleware system for request/response processing
38
- - **Deploy Anywhere** - Deploy to any platform.
39
- - **Vercel Support** - Built-in support for Vercel deployment
36
+ ⊹ **File System Routing** - Tools are auto-registered from a `tools` directory\
37
+ ⊹ **Hot Reloading** - Instant development feedback\
38
+ ⊹ **Middlewares** - Toolkit for shipping authentication and custom middlewares\
39
+ ⊹ **Extensible Configuration** - Customizable configuration for your MCP server\
40
+ ⊹ **Deploy Anywhere** - Flexible deployment across any platform\
41
+ ⊹ **Vercel Support** - Deploy-ready for Vercel out of the box
42
+
43
+ ## Learn more
44
+
45
+ ⊹ Visit [xmcp.dev](https://xmcp.dev) to learn more about the project.\
46
+ ⊹ Visit [xmcp.dev/docs](https://xmcp.dev/docs) to view the full documentation.
40
47
 
41
48
  ## Security
42
49