Skip to content

Commit a3d826f

Browse files
authored
Merge branch 'main' into main
2 parents 94d48cf + 4628335 commit a3d826f

File tree

11 files changed

+593
-1183
lines changed

11 files changed

+593
-1183
lines changed

.cursor/rules/mcp-framework.mdc

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,86 @@ Servers offer any of the following features to clients:
2929
Resources: Context and data, for the user or the AI model to use
3030
Prompts: Templated messages and workflows for users
3131
Tools: Functions for the AI model to execute</specification>
32+
33+
Here is an example of how a user creats an mcp server using mcp-framework as the library: <example>## src/tools/ExampleTool.ts
34+
35+
```ts
36+
import { MCPTool } from "mcp-framework";
37+
import { z } from "zod";
38+
39+
interface ExampleInput {
40+
message: string;
41+
}
42+
43+
class ExampleTool extends MCPTool<ExampleInput> {
44+
name = "example_tool";
45+
description = "An example tool that processes messages";
46+
47+
schema = {
48+
message: {
49+
type: z.string(),
50+
description: "Message to process",
51+
},
52+
};
53+
54+
async execute(input: ExampleInput) {
55+
return `Processed: ${input.message}`;
56+
}
57+
}
58+
59+
export default ExampleTool;
60+
```
61+
62+
## src/index.ts
63+
64+
```ts
65+
import { MCPServer } from "mcp-framework";
66+
67+
const server = new MCPServer({transport:{
68+
type:"http-stream",
69+
options:{
70+
port:1337,
71+
cors: {
72+
allowOrigin:"*"
73+
}
74+
}
75+
}});
76+
77+
server.start();
78+
79+
```
80+
81+
## package.json
82+
83+
```json
84+
{
85+
"name": "http2-hi",
86+
"version": "0.0.1",
87+
"description": "http2-hi MCP server",
88+
"type": "module",
89+
"bin": {
90+
"http2-hi": "./dist/index.js"
91+
},
92+
"files": [
93+
"dist"
94+
],
95+
"scripts": {
96+
"build": "tsc && mcp-build",
97+
"watch": "tsc --watch",
98+
"start": "node dist/index.js"
99+
},
100+
"dependencies": {
101+
"mcp-framework": "^0.2.12-beta.4",
102+
"zod": "^3.24.4"
103+
},
104+
"devDependencies": {
105+
"@types/node": "^20.11.24",
106+
"typescript": "^5.3.3"
107+
},
108+
"engines": {
109+
"node": ">=18.19.0"
110+
}
111+
}
112+
113+
```
114+
</example>

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ README
55
.DS_Store
66
dist
77
node_modules
8-
.cursor

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.2.11"
2+
".": "0.2.13"
33
}

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.2.13](https://github.com/QuantGeekDev/mcp-framework/compare/mcp-framework-v0.2.12...mcp-framework-v0.2.13) (2025-05-23)
9+
10+
11+
### Bug Fixes
12+
13+
* properly support required/optional tool input schema ([1583603](https://github.com/QuantGeekDev/mcp-framework/commit/1583603b2613b8c7c57ebbd52fb5c8159d0b8d13))
14+
15+
## [0.2.12](https://github.com/QuantGeekDev/mcp-framework/compare/mcp-framework-v0.2.11...mcp-framework-v0.2.12) (2025-05-23)
16+
17+
18+
### Features
19+
20+
* bump mcp ts sdk version ([d9cc845](https://github.com/QuantGeekDev/mcp-framework/commit/d9cc8450d39e89f36e39e78bb4d1946cf5f858d3))
21+
* enhanced cursor rule with example ([d3b54d4](https://github.com/QuantGeekDev/mcp-framework/commit/d3b54d4619e669ad322484b074a82aae27d61ae9))
22+
* replace custom implementation with sdk delegation ([1b5b8e7](https://github.com/QuantGeekDev/mcp-framework/commit/1b5b8e7cbe354056856a565b21b8908eb93ac2ba))
23+
824
## [0.2.11](https://github.com/QuantGeekDev/mcp-framework/compare/mcp-framework-v0.2.10...mcp-framework-v0.2.11) (2025-03-30)
925

1026

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ MCP-Framework gives you architecture out of the box, with automatic directory-ba
1313
- Easy-to-use base classes for tools, prompts, and resources
1414
- Out of the box authentication for SSE endpoints
1515

16+
## Projects Built with MCP Framework
17+
18+
The following projects and services are built using MCP Framework:
19+
20+
- ### [tip.md](https://tip.md)
21+
A crypto tipping service that enables AI assistants to help users send cryptocurrency tips to content creators directly from their chat interface. The MCP service allows for:
22+
- Checking wallet types for users
23+
- Preparing cryptocurrency tips for users/agents to complete
24+
Setup instructions for various clients (Cursor, Sage, Claude Desktop) are available in their [MCP Server documentation](https://docs.tip.md/mcp-server/).
1625

1726
# [Read the full docs here](https://mcp-framework.com)
1827

@@ -417,6 +426,9 @@ class CustomAuthProvider implements AuthProvider {
417426
}
418427
}
419428
```
429+
## Support our work
430+
431+
[![Tip in Crypto](https://tip.md/badge.svg)](https://tip.md/tipdotmd)
420432
421433
## License
422434

package-lock.json

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mcp-framework",
3-
"version": "0.2.11",
3+
"version": "0.2.13",
44
"description": "Framework for building Model Context Protocol (MCP) servers in Typescript",
55
"type": "module",
66
"author": "Alex Andru <[email protected]>",
@@ -26,6 +26,7 @@
2626
"lint:fix": "eslint --fix",
2727
"format": "prettier --write \"src/**/*.ts\"",
2828
"prepare": "npm run build"
29+
"dev:pub": "rm -rf dist && npm run build && yalc publish --push"
2930
},
3031
"engines": {
3132
"node": ">=18.19.0"
@@ -43,7 +44,7 @@
4344
"protocol"
4445
],
4546
"peerDependencies": {
46-
"@modelcontextprotocol/sdk": "1.8"
47+
"@modelcontextprotocol/sdk": "^1.11.0"
4748
},
4849
"dependencies": {
4950
"@types/prompts": "^2.4.9",

0 commit comments

Comments
 (0)