my-mcp-server
Description
# my-mcp-server A Model Context Protocol (MCP) server built with mcp-framework. ## Quick Start ```bash # Install dependencies npm install # Build the project npm run build ``` ## Project Structure ``` my-mcp-server/ ├── src/ │ ├── tools/ # MCP Tools │ │ └── ExampleTool.ts │ └──…
About
# my-mcp-server A Model Context Protocol (MCP) server built with mcp-framework. ## Quick Start ```bash # Install dependencies npm install # Build the project npm run build ``` ## Project Structure ``` my-mcp-server/ ├── src/ │ ├── tools/ # MCP Tools │ │ └── ExampleTool.ts │ └── index.ts # Server entry point ├──…
Details
- Author
- zaruous
- Downloads
- 291
- Categories
- Other
Jump to
- Built with the mcp-framework for rapid MCP server development.
- Includes an example tool (ExampleTool.ts) to get started.
- CLI command to add new tools (mcp add tool).
- Uses Zod for runtime input validation.
- Easy npm publishing for sharing your server.
- Pre‑configured to work with Claude Desktop.
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
my-mcp-serverCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Install dependencies and build with npm install && npm run build. Then configure the server in your Claude Desktop config file (e.g., claude_desktop_config.json) by pointing it to the compiled dist/index.js (local) or using npx my-mcp-server (published). Tools can be added via the mcp add tool <name> command.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"my-mcp-server": {
"my-mcp-server": {
"command": "node",
"args": [
"/absolute/path/to/my-mcp-server/dist/index.js"
]
}
}
}
}McpServers
{
"my-mcp-server": {
"command": "node",
"args": [
"/absolute/path/to/my-mcp-server/dist/index.js"
]
}
}my-mcp-server
A Model Context Protocol (MCP) server built with mcp-framework.
Quick Start
# Install dependencies
npm install
Build the project
npm run build
Project Structure
my-mcp-server/
├── src/
│ ├── tools/ # MCP Tools
│ │ └── ExampleTool.ts
│ └── index.ts # Server entry point
├── package.json
└── tsconfig.json
Adding Components
The project comes with an example tool in src/tools/ExampleTool.ts. You can add more tools using the CLI:
# Add a new tool
mcp add tool my-tool
Example tools you might create:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler
Tool Development
Example tool structure:
import { MCPTool } from "mcp-framework";
import { z } from "zod";
interface MyToolInput {
message: string;
}
class MyTool extends MCPTool<MyToolInput> {
name = "my_tool";
description = "Describes what your tool does";
schema = {
message: {
type: z.string(),
description: "Description of this input parameter",
},
};
async execute(input: MyToolInput) {
// Your tool logic here
return Processed: ${input.message};
}
}
export default MyTool;
Publishing to npm
1. Update your package.json:
- Ensure name is unique and follows npm naming conventions
- Set appropriate version
- Add description, author, license, etc.
- Check bin points to the correct entry file
2. Build and test locally:
npm run build
npm link
my-mcp-server # Test your CLI locally
3. Login to npm (create account if necessary):
npm login
4. Publish your package:
npm publish
After publishing, users can add it to their claude desktop client (read below) or run it with npx
Using with Claude Desktop
Local Development
Add this configuration to your Claude Desktop config file:
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"my-mcp-server": {
"command": "node",
"args":["/absolute/path/to/my-mcp-server/dist/index.js"]
}
}
}
After Publishing
Add this configuration to your Claude Desktop config file:
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"my-mcp-server": {
"command": "npx",
"args": ["my-mcp-server"]
}
}
}
``
Building and Testing
1. Make changes to your tools
2. Run
npm run build` to compile3. The server will automatically load your tools on startup
Learn More
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
