Skip to content

Commit 4200bf0

Browse files
committed
chore: rename project
1 parent 244c95e commit 4200bf0

File tree

4 files changed

+38
-102
lines changed

4 files changed

+38
-102
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77

88
jobs:
99
build:
10-
if: github.repository == 'my-mcp-hub/node-mcp-server'
10+
if: github.repository == 'computer-mcp-server'
1111
runs-on: ubuntu-latest
1212
steps:
1313
- name: Checkout

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
jobs:
88
build:
9-
if: github.repository == 'my-mcp-hub/node-mcp-server'
9+
if: github.repository == 'computer-mcp-server'
1010
runs-on: ubuntu-latest
1111
permissions:
1212
contents: read

README.md

Lines changed: 33 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,44 @@
1-
# Node.js MCP Server Template
1+
# Computer MCP Server
22

3-
A Model Context Protocol (MCP) server template for Node.js applications. This template provides a foundation for building MCP-compatible servers with support for multiple transport protocols.
3+
A computer mcp server
44

5-
[![][npm-release-shield]][npm-release-link]
6-
[![][codecov-shield]][codecov-link]
7-
[![][github-release-date-shield]][github-release-date-link]
8-
[![][github-action-build-shield]][github-action-build-link]
9-
[![][github-license-shield]][github-license-link]
5+
## Setup
106

11-
## Features
12-
- Multiple Transport Protocols :
7+
### Usage
8+
To use with `Desktop APP`, such as Claude, VSCode, [Cline](https://cline.bot/mcp-marketplace), Cherry Studio, Cursor, and so on, add the MCP server config below.
139

14-
- Standard I/O (stdio) for command-line interfaces
15-
- HTTP Streamable transport for web applications
16-
- Server-Sent Events (SSE) for real-time updates
17-
- TypeScript Support : Built with TypeScript for type safety and better developer experience
18-
- Development Tools :
19-
20-
- Hot reloading during development
21-
- Integration with MCP Inspector for debugging
22-
- ESLint and Prettier for code quality
23-
- Husky and lint-staged for Git hooks
24-
- Extensible Tool System : Easy registration of custom MCP tools
25-
26-
## Prerequisites
27-
- Node.js (latest LTS version recommended)
28-
- npm or yarn
29-
30-
## Installation
31-
32-
```bash
33-
npm install
34-
```
35-
36-
## Development
37-
```bash
38-
# Start development server with stdio transport
39-
npm run dev
40-
41-
# Start development server with web transport
42-
npm run dev:web
43-
```
44-
45-
When using dev:web , the server will be available at:
46-
47-
- Streamable HTTP endpoint: http://localhost:8401/mcp
48-
- SSE endpoint: http://localhost:8401/sse
49-
50-
## Building
51-
```bash
52-
npm run build
53-
```
54-
The build output will be in the build directory.
55-
56-
## Usage
57-
### Command Line
58-
```bash
59-
# Start with stdio transport (default)
60-
node build/index.js
61-
62-
# Start with web transport
63-
node build/index.js web --port 8401
10+
On Mac system:
11+
```json
12+
{
13+
"mcpServers": {
14+
"computer-mcp-server": {
15+
"command": "npx",
16+
"args": [
17+
"-y",
18+
"computer-mcp-server"
19+
]
20+
}
21+
}
22+
}
6423
```
65-
### Adding Custom Tools
66-
Custom tools can be added in the src/tools/index.ts file:
6724

68-
```ts
69-
server.registerTool(
70-
'YourToolName',
71-
{
72-
title: 'Your Tool Name',
73-
description: 'Tool description',
74-
inputSchema: {
75-
param1: z.string().describe('Parameter description'),
76-
},
77-
},
78-
({ param1 }) => {
79-
// Implement tool logic
80-
return {
81-
content: [
82-
{
83-
type: 'text',
84-
text: `Your tool response: ${param1}`,
85-
},
86-
],
25+
On Window system:
26+
27+
```json
28+
{
29+
"mcpServers": {
30+
"computer-mcp-server": {
31+
"command": "cmd",
32+
"args": [
33+
"/c",
34+
"npx",
35+
"-y",
36+
"computer-mcp-server"
37+
]
8738
}
88-
},
89-
)
39+
}
40+
}
9041
```
9142

92-
## Environment Variables
93-
- PORT : Specify the port for web transport (default: 8401)
94-
- NODE_ENV : Set to production for production builds or local for development
95-
9643
## License
9744
[MIT](LICENSE)
98-
99-
[npm-release-link]: https://www.npmjs.com/package/@my-mcp-hub/node-mcp-server
100-
[npm-release-shield]: https://img.shields.io/npm/v/@my-mcp-hub/node-mcp-server?color=1677FF&labelColor=black&logo=npm&logoColor=white&style=flat-square
101-
[codecov-link]: https://coveralls.io/github/my-mcp-hub/node-mcp-server?branch=main
102-
[codecov-shield]: https://img.shields.io/coverallsCoverage/github/my-mcp-hub/node-mcp-server?color=1677FF&labelColor=black&style=flat-square&logo=codecov&logoColor=white
103-
[github-release-date-link]: https://github.com/my-mcp-hub/node-mcp-server/releases
104-
[github-release-date-shield]: https://img.shields.io/github/release-date/my-mcp-hub/node-mcp-server?color=1677FF&labelColor=black&style=flat-square
105-
[github-action-build-link]: https://github.com/my-mcp-hub/node-mcp-server/actions/workflows/build.yml
106-
[github-action-build-shield]: https://img.shields.io/github/actions/workflow/status/my-mcp-hub/node-mcp-server/build.yml?branch=main&color=1677FF&label=build&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
107-
[github-license-link]: https://github.com/my-mcp-hub/node-mcp-server/blob/main/LICENSE
108-
[github-license-shield]: https://img.shields.io/github/license/my-mcp-hub/node-mcp-server?color=1677FF&labelColor=black&style=flat-square

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@my-mcp-hub/node-mcp-server",
3-
"version": "0.0.2",
4-
"description": "MCP Server Template For Node.js",
2+
"name": "computer-mcp-server",
3+
"version": "0.0.1",
4+
"description": "A computer mcp server",
55
"author": "zhensherlock",
66
"type": "module",
77
"license": "MIT",

0 commit comments

Comments
 (0)