使用说明
MCP市场SDK
用于访问MCP(模型上下文协议)应用程序市场API的TypeScript SDK。此monorepo包含两个包:
- @mcp市场/类型 -MCP Marketplace的TypeScript类型定义
- @mcp市场/客户端sdk -适用于浏览器和Node.js的全功能客户端SDK
安装
类型包装
npm install @mcp-marketplace/types
客户端SDK
npm install @mcp-marketplace/client-sdk
客户端SDK包含作为依赖项的类型包,因此只有在使用完整的API客户端时才需要安装客户端SDK。
快速开始
使用客户端SDK
import { createMarketplaceClient } from '@mcp-marketplace/client-sdk';
const client = createMarketplaceClient({
baseUrl: 'https://marketplace.example.com',
apiKey: 'your-api-key', // optional
getUserId: () => 'user-123' // optional
});
// List all apps
const apps = await client.listApps();
// Search apps
const results = await client.searchApps('weather');
// Get app details
const app = await client.getApp('app-id');
// Download app package
const blob = await client.downloadApp('app-id');
仅使用类型
import type { MCPApp, AppManifest } from '@mcp-marketplace/types';
const app: MCPApp = {
id: 'app-1',
name: 'My App',
// ...
};
包裹
@mcp市场/类型
MCP Marketplace实体的TypeScript类型定义包括:
MCPApp-应用元数据和配置AppManifest-应用程序清单结构MCPServer-服务器配置MCPTool-工具定义
看 类型包README 获取完整文档。
@mcp市场/客户端sdk
功能齐全的SDK,包括以下方法:
- 列出和搜索应用程序
- 获取应用程序详细信息和清单
- 正在下载应用程序包
- 上传应用程序(面向开发人员)
- 健康检查
- 账户管理
看 客户端SDK自述 获取完整的API文档。
发展
这是一个使用npm workspaces的monorepo。
设置
npm install
构建
npm run build
这将构建工作区中的所有包。
发展模式
npm run dev
在监视模式下为所有包运行TypeScript编译器。
贡献
我们欢迎捐款!请随时提交拉取请求。对于重大更改,请先打开一个问题来讨论您想要更改的内容。
开发流程
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 进行更改并运行
npm run build验证 - 提交您的更改(
git commit -m 'Add amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
运行测试
npm run test
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。
仓库
- github: https://github.com/ggange/mcp-marketplace
- npm: @mcp市场/类型 | @mcp市场/客户端sdk
支持
有关问题和疑问,请使用 GitHub问题 页面。
作者
Giuseppe Matteo Gangemi
