mcp-server-template

# [模板] MCP Server ## 如何使用此模板 - 在 src/index.ts 中添加工具定义 - 更新下面的 README - 更新 package.json 中的占位符信息 - 使用 `npm run build` 测试构建 MCP server，并使用 @modelcontextprotocol/inspector 库 - 发布到 npm: `npm login`, `npm publish --access public` ## 概述 [在此插入概述] ## 特性 [在此插入特性] ## 设置 1. 创建 API 密钥等。 2. 将令牌设置为环境变量： ```bash export API_KEY_ENV_VAR=the_secret_api_key ``` ## 使用 ### 与 VS Code 一起使用 将以下内容添加到您的设置 JSON 文件中： ```json { "mcp": { "inputs": [ { "type": "promptString", "id": "some_secret_api_key", "description": "秘密 API 密钥", "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 文件中： ```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 来尝试服务器： ```bash npx @modelcontextprotocol/inspector npx tsx src/index.ts ``` ## 限制与未来改进 ## 许可证 MIT