https://github.com/larryhudson/mcp-server-template
A template for making an MCP server with TypeScript
https://github.com/larryhudson/mcp-server-template
Last synced: 25 days ago
JSON representation
A template for making an MCP server with TypeScript
- Host: GitHub
- URL: https://github.com/larryhudson/mcp-server-template
- Owner: larryhudson
- License: mit
- Created: 2025-04-26T13:28:13.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-27T10:23:10.000Z (5 months ago)
- Last Synced: 2025-06-19T01:39:40.737Z (4 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - larryhudson/mcp-server-template
README
# [Template] MCP Server
## How to use this template
- Add tool definitions in src/index.ts
- Update the README below
- Update the placeholder info in package.json
- Test building the MCP server with `npm run build`, and using the @modelcontextprotocol/inspector library
- Publish to npm: `npm login`, `npm publish --access public`
## Overview
[Insert overview here]
## Features
[Insert features here]
## Setup
1. Create a API key etc.
2. Set the token as an environment variable:
```bash
export API_KEY_ENV_VAR=the_secret_api_key
```
## Usage
### Using with VS Code
Add this to your settings JSON file:
```json
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "some_secret_api_key",
"description": "Secret API key",
"password": true
}
],
"servers": {
"[library-name]": {
"command": "npx",
"args": [
"-y",
"@larryhudson/[the-library]"
],
"env": {
"API_KEY_ENV_VAR": "${input:some_secret_api_key}"
}
}
}
}
}
```
### Using with Claude or other MCP-compatible applications
Add this to your MCP configuration JSON file:
```json
{
"mcpServers": {
"[the-library]": {
"command": "npx",
"args": ["-y", "@larryhudson/[the-library]"],
"env": {
"API_KEY_ENV_VAR": ""
}
}
}
}
```
## Available Tools
[List the tools here]
## How It Works
[Some info about how it works]
## Technical Details
Built with:
- **Model Context Protocol (MCP)**: Framework for allowing AI assistants to interact with external tools
- **TypeScript**: For type safety and better developer experience
## Development
You can use the Model Context Protocol inspector to try out the server:
```bash
npx @modelcontextprotocol/inspector npx tsx src/index.ts
```
## Limitations and Future Improvements
## License
MIT