https://github.com/mizchi/mcp-helper
https://github.com/mizchi/mcp-helper
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/mizchi/mcp-helper
- Owner: mizchi
- Created: 2025-02-21T16:03:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T08:26:50.000Z (4 months ago)
- Last Synced: 2025-03-16T07:41:22.006Z (3 months ago)
- Language: TypeScript
- Size: 31.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - mizchi/mcp-helper - (TypeScript)
README
# @mizchi/mcp-helper
A type-safe helper library for creating Model Context Protocol (MCP) servers in Deno.
## Features
- Type-safe MCP server creation with TypeScript
- Zod schema validation for input/output
- In-memory test client for easy testing
- Built-in TypeScript type inference for tools
## Installation
```ts
import { createToolsServer } from "jsr:@mizchi/mcp-helper";
```
## Usage
### Creating an MCP Server
```ts
import { createToolsServer } from "jsr:@mizchi/mcp-helper";
import { StdioServerTransport } from "npm:@modelcontextprotocol/[email protected]/server/stdio.js";
import { z } from "zod";
// Define your tools with Zod schemas
const tools = [
{
name: "getStringLength",
description: "Get length of input string",
inputSchema: z.object({
input: z.string().describe("The input string"),
}),
outputSchema: z.number(),
},
] as const;
// Create the server with type-safe handlers
const server = createToolsServer(
{
name: "my-server",
version: "1.0.0",
},
tools,
// define handlers for all tools
{
getStringLength(params: { input: string }) {
return params.input.length;
},
}
);
await server.connect(new StdioServerTransport());
```
### Testing Your Server
The library provides an in-memory test client for easy testing:
```ts
import { createInMemoryTestClient } from "@mizchi/mcp-helper";
// Create a test client
const client = await createInMemoryTestClient(server);
// Call tools with type safety
const result = await client.callTool("getStringLength", {
input: "Hello, world!",
});
console.log(result); // 13
// Clean up
await client.close();
```
### MCP Configuration
Add your server to the MCP configuration:
```json
{
"mcpServers": {
"mymcp": {
"command": "deno",
"args": ["run", "-A", "server.ts"],
"env": {},
"disabled": false,
"alwaysAllow": []
}
}
}
```
## API
### `createToolsServer(info, tools, handlers)`
Creates a new MCP server with type-safe tool definitions.
- `info`: Server information (name and version)
- `tools`: Array of tool definitions with Zod schemas
- `handlers`: Implementation of tool handlers
### `createInMemoryTestClient(server)`
Creates a test client for the given server.
- `server`: The MCP server instance
- Returns: A type-safe client for testing tools
## CLI (Experimental)
**CAUTION**: You can not install cli via jsr for dynamic import restrictions.
```bash
# Install cli
$ deno install -Afg ./lmcp.ts -A
$ lmcp examples/readUrl.ts readUrl -- --url=https://zenn.dev/mizchi/articles/deno-mcp-server
```
Add this export for your server impl.
```ts
// add this export for impl
export default server;
```
## Development
```bash
# Run tests
deno task test
```
## License
MIT