返回 MCP 目录
public公开dns本地运行

mcp-server

这是一个用于快速启动和运行MCP服务器开发环境的项目,提供TypeScript示例代码和生成工具。

article

README

🚀 开发容器快速入门

本项目提供了开发容器的快速使用指南,帮助你快速上手相关开发。默认情况下,使用示例片段存放在 samples 目录中。

🚀 快速开始

运行使用示例

root.ts 文件中提供了一个示例使用案例。在使用 SDK 时,你可以根据自身需求修改这些示例。若要执行此特定示例片段,请使用以下命令:

ts-node root.ts

生成更多使用示例

使用 speakeasy CLI 可以生成更多使用示例片段,具体方法如下:

  • 按操作 ID 生成特定操作的示例: 使用以下命令,通过提供操作 ID 来生成特定操作的示例:
speakeasy generate usage -s ./schemas/openapi.json -l typescript -i {INPUT_OPERATION_ID} -o ./samples
  • 按命名空间生成示例: 若要为整个命名空间(如标签或组名)生成示例,请使用以下命令:
speakeasy generate usage -s ./schemas/openapi.json -l typescript -n {INPUT_TAG_NAME} -o ./samples

⚠️ 重要提示

当不使用 GitHub Codespace 时,请记得关闭它!

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端