mcpField
[
[Template] MCP Server

[Template] MCP Server

本地服务
github.com/larryhudson开发工具179 周前更新
代码仓库

关于 [Template] MCP Server

这是一个用于创建 TypeScript MCP 服务的模板，面向希望添加工具并构建、发布服务的开发者。README 主要提供模板使用步骤和 MCP Inspector 测试指引，具体工具与功能仍需自行填写。

主要功能

  1. 01TypeScript 项目模板
  2. 02在 src/index.ts 添加工具
  3. 03npm 构建与发布指引
  4. 04MCP Inspector 测试指引

适用场景

  1. 01创建 TypeScript MCP 服务
  2. 02定义并测试自有工具
  3. 03构建并发布 npm 包

MCP 相关

该模板用于创建 MCP 服务，供兼容 MCP 的应用连接；具体暴露的工具由开发者添加。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "template-larryhudson": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/inspector"
      ]
    }
  }
}
启动命令npx -y @modelcontextprotocol/inspector

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npm@modelcontextprotocol/inspector

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具，维护者暂未提供工具列表。

详细介绍

[模板] MCP 服务

如何使用此模板

  • 在 src/index.ts 中添加工具定义
  • 更新下方的 README
  • 更新 package.json 中的占位信息
  • 使用 npm run build 构建 MCP 服务，并使用 @modelcontextprotocol/inspector 库进行测试
  • 发布到 npm：npm login，npm publish --access public

概述

[在此插入概述]

功能

[在此插入功能]

设置

  1. 创建 API 密钥等。
  2. 将令牌设为环境变量：
export API_KEY_ENV_VAR=the_secret_api_key

用法

在 VS Code 中使用

将以下内容添加到 settings 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}"
        }
      }
    }
  }
}
在 Claude 或其他兼容 MCP 的应用程序中使用

将以下内容添加到 MCP 配置 JSON 文件中：

{
  "mcpServers": {
    "[the-library]": {
      "command": "npx",
      "args": ["-y", "@larryhudson/[the-library]"],
      "env": {
        "API_KEY_ENV_VAR": "<THE_SECRET_API_KEY>"
      }
    }
  }
}

可用工具

[在此列出工具]

工作原理

[一些关于工作原理的信息]

技术详情

使用以下技术构建：

  • Model Context Protocol (MCP)：让 AI 助手能够与外部工具交互的框架
  • TypeScript：提供类型安全和更好的开发体验

开发

你可以使用 Model Context Protocol inspector 试用此服务：

npx @modelcontextprotocol/inspector npx tsx src/index.ts

限制与未来改进

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。