{"_id":"@archiesun/alibabacloud-oss-mcp-server","name":"@archiesun/alibabacloud-oss-mcp-server","dist-tags":{"alpha":"1.0.0-alpha.3","latest":"1.0.0-alpha.3"},"versions":{"1.0.0-alpha.3":{"name":"@archiesun/alibabacloud-oss-mcp-server","version":"1.0.0-alpha.3","description":"Alibaba Cloud Object Storage Service (OSS) MCP Server, built on the Model Context Protocol (MCP), enables developers to quickly integrate OSS data management capabilities into AI applications.","type":"module","engines":{"node":">=18.20.5"},"bin":{"alibabacloud-oss-mcp-server":"dist/index.js"},"exports":{".":null,"./server":{"import":"./dist/server.js","types":"./dist/server.d.ts"},"./types":{"import":"./dist/types.js","types":"./dist/types.d.ts"}},"scripts":{"build":"tsc -p tsconfig.production.json","publish-check":"node script/publishCheck.js","test":"vitest --run","type-check":"tsc --noEmit","prepare":"husky"},"keywords":["alibabacloud","aliyun","oss","mcp","ai"],"author":{"name":"Alibaba Cloud OSS"},"license":"MIT","homepage":"https://github.com/aliyun/alibabacloud-oss-mcp-server","repository":{"type":"git","url":"git+https://github.com/aliyun/alibabacloud-oss-mcp-server.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"devDependencies":{"@commitlint/cli":"^20.1.0","@commitlint/config-conventional":"^20.0.0","@types/express":"^5.0.5","@types/node":"^18.19.130","@typescript-eslint/eslint-plugin":"^8.46.2","@typescript-eslint/parser":"^8.46.2","@vitest/coverage-v8":"^3.2.4","eslint":"^9.38.0","eslint-config-prettier":"^10.1.8","eslint-import-resolver-typescript":"^4.4.4","eslint-plugin-import":"^2.32.0","globby":"^14.1.0","husky":"^9.1.7","lint-staged":"^15.5.2","prettier":"^3.6.2","typescript":"^5.9.3","typescript-eslint":"^8.46.3","vitest":"^3.2.4"},"dependencies":{"@modelcontextprotocol/sdk":"^1.24.2","ali-oss":"7.0.0-dev.1","zod":"^3.25.76"},"peerDependencies":{"express":"^5.1.0"},"peerDependenciesMeta":{"express":{"optional":true}},"gitHead":"654d4be829e87190647786037996dbbd56b1f83c","_id":"@archiesun/alibabacloud-oss-mcp-server@1.0.0-alpha.3","bugs":{"url":"https://github.com/aliyun/alibabacloud-oss-mcp-server/issues"},"_nodeVersion":"24.13.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-IHoExubiIY5bEDcudTXJOw2AU8gMHzBanF6fI2yB+WpLL9NM+epqyOMy8/zrG+cmZwJkmx2qcpzViUC0FkmE+g==","shasum":"28996ebc8d1206da1c662cd9000aaa266521596f","tarball":"https://registry.npmjs.org/@archiesun/alibabacloud-oss-mcp-server/-/alibabacloud-oss-mcp-server-1.0.0-alpha.3.tgz","fileCount":35,"unpackedSize":69904,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDH0QU8cPHSD0n5AS9p4zvKx+J/zcX0pKLQZaJxMMK2PQIgbEN2UoMBEgH+xG1stijgwvyJ/UHM5gOtDcbual52bAs="}]},"_npmUser":{"name":"archiesun","email":"sunzhe1988@live.cn"},"directories":{},"maintainers":[{"name":"archiesun","email":"sunzhe1988@live.cn"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/alibabacloud-oss-mcp-server_1.0.0-alpha.3_1772639419982_0.5693923044100946"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-04T15:50:19.899Z","1.0.0-alpha.3":"2026-03-04T15:50:20.135Z","modified":"2026-03-04T15:50:20.334Z"},"maintainers":[{"name":"archiesun","email":"sunzhe1988@live.cn"}],"description":"Alibaba Cloud Object Storage Service (OSS) MCP Server, built on the Model Context Protocol (MCP), enables developers to quickly integrate OSS data management capabilities into AI applications.","homepage":"https://github.com/aliyun/alibabacloud-oss-mcp-server","keywords":["alibabacloud","aliyun","oss","mcp","ai"],"repository":{"type":"git","url":"git+https://github.com/aliyun/alibabacloud-oss-mcp-server.git"},"author":{"name":"Alibaba Cloud OSS"},"bugs":{"url":"https://github.com/aliyun/alibabacloud-oss-mcp-server/issues"},"license":"MIT","readme":"# 对象存储（OSS）MCP Server（Alpha）\r\n\r\n基于 Model Context Protocol（MCP）的阿里云对象存储（OSS）MCP Server，帮助开发者快速将 OSS 数据管理能力集成到 AI 应用中。\r\n\r\n> ⚠️ 注意：这是一个 Alpha 版本，可能会有重大变更。\r\n\r\n## 环境要求\r\n\r\nNode.js >= 18.20.5\r\n\r\n## 安装\r\n\r\n```bash\r\nnpm install alibabacloud-oss-mcp-server@alpha\r\n```\r\n\r\n或\r\n\r\n```bash\r\nnpm install alibabacloud-oss-mcp-server@1.0.0-alpha.2\r\n```\r\n\r\n### 可选依赖\r\n\r\n如使用Streamable HTTP 通信方式，直接在 AI 客户端中或通过编程方式但未设置`httpServer`选项时使用，则需要额外安装 Express：\r\n\r\n```bash\r\nnpm install express\r\n```\r\n\r\n## 功能特性\r\n\r\n提供以下 MCP Server 工具供客户端调用：\r\n\r\n### 列举存储空间（ListBuckets）\r\n\r\n支持参数：\r\n- `[prefix]`：限定返回的存储空间名称必须包含的前缀\r\n- `[marker]`：设定结果从 marker 之后按字母排序的第一个开始返回\r\n- `[maxKeys]`：请求返回的最大存储空间数目，默认值为 100，其可设置的最大值可在 OSS MCP Server 实例中配置\r\n- `[resourceGroupId]`：指定返回的存储空间资源组 ID\r\n- `[region]`：OSS 专用地域标识，如 oss-cn-hangzhou，用于指定请求使用的访问域名\r\n\r\n### 查看存储空间的相关信息（GetBucketInfo）\r\n\r\n支持参数：\r\n- `bucket`：存储空间名称\r\n- `[region]`：OSS 专用地域标识，如 oss-cn-hangzhou，用于指定请求使用的访问域名\r\n\r\n### 获取指定存储空间的存储容量、文件以及 Multipart 分片数量（GetBucketStat）\r\n\r\n支持参数：\r\n- `bucket`：存储空间名称\r\n- `[region]`：OSS 专用地域标识，如 oss-cn-hangzhou，用于指定请求使用的访问域名\r\n\r\n## 使用方式\r\n\r\n### 在 AI 客户端中使用（以 Cherry Studio 为例）\r\n\r\n#### 准备工作\r\n\r\n1. 安装 Cherry Studio，进入设置界面\r\n2. 点击 “MCP” 选项，根据提示安装 MCP 环境依赖\r\n3. 配置以下环境变量：\r\n   - `OSS_ACCESS_KEY_ID`：访问密钥 ID\r\n   - `OSS_ACCESS_KEY_SECRET`：访问密钥\r\n   - `OSS_SECURITY_TOKEN`：（可选）安全令牌，使用临时身份凭证时需要设置\r\n   - `OSS_REGION`：（可选）OSS 专用地域标识，如 oss-cn-hangzhou\r\n   - `OSS_ENDPOINT`：（可选）访问域名\r\n\r\n#### 方法一：使用标准输入/输出（stdio）通信\r\n\r\n1. 点击“添加”，设置名称、描述等选项，类型选项选择“标准输入/输出”\r\n2. 命令选项填写`node`\r\n3. 参数选项填写工具的安装路径，如`/Users/test/yourProject/node_modules/alibabacloud-oss-mcp-server/dist/index.js`\r\n4. 保存配置并启用服务\r\n\r\n#### 方法二：使用 Streamable HTTP 通信\r\n\r\n1. 在您的项目目录下，通过命令行启动本地服务，如：\r\n   ```bash\r\n   npx alibabacloud-oss-mcp-server --transport=streamable-http --port=18081\r\n   ```\r\n   \r\n   或\r\n   \r\n   ```bash\r\n   node ./node_modules/alibabacloud-oss-mcp-server --transport=streamable-http --port=18081\r\n   ```\r\n   \r\n   支持指定以下参数：\r\n   - `--transport=streamable-http`：指定通信类型为 Streamable HTTP\r\n   - `--port=<number>`：（可选）指定监听端口，默认为 18081\r\n2. 进入 Cherry Studio 设置页面，点击 “MCP” 选项\r\n3. 点击“添加”，设置名称、描述等选项，类型选项选择“可流式传输的 HTTP”\r\n4. URL 选项填写本地服务启动的 URL，如`http://localhost:18081/mcp`\r\n5. 保存配置并启用服务\r\n\r\n## 编程方式使用\r\n\r\n### 基础用法\r\n\r\n```typescript\r\nimport { OSSMcpServer, OSSMcpServerTransport } from 'alibabacloud-oss-mcp-server/server';\r\n\r\nconst server = new OSSMcpServer({\r\n  accessKeyId: process.env.OSS_ACCESS_KEY_ID,\r\n  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,\r\n  securityToken: process.env.OSS_SECURITY_TOKEN,\r\n  region: process.env.OSS_REGION,\r\n  endpoint: process.env.OSS_ENDPOINT\r\n});\r\n\r\nserver.runServer();\r\n```\r\n\r\n### 配置选项\r\n\r\n创建 OSSMcpServer 实例时，您可以传入以下配置选项：\r\n\r\n#### OSS 客户端配置\r\n- `accessKeyId`：访问密钥 ID\r\n- `accessKeySecret`：访问密钥\r\n- `[securityToken]`：安全令牌\r\n- `[refreshCredentials]`：更新访问凭证方法，若使用临时身份凭证，建议设置该值及`refreshCredentialsInterval`参数，防止临时身份凭证过期\r\n- `[refreshCredentialsInterval]`：访问凭证有效期，单位：毫秒（ms），默认值为300000 ms，即5分钟\r\n- `[lastRefreshCredentialsTime]`：访问凭证最近更新时间，默认值为初始化客户端实例的时间\r\n- `[region]`：地域 ID 或 OSS 专用地域标识，默认值为 oss-cn-hangzhou，此参数将统一转化为地域 ID 用于签名\r\n- `[endpoint]`：访问域名，默认使用`region`参数生成外网访问域名，设置该值则忽略`internal`参数，若该值携带协议部分，则忽略`secure`参数。若`region`参数设置为地域ID或需要使用其他域名访问 OSS，请务必设置此参数\r\n- `[internal]`：是否使用内网访问域名，默认值为false\r\n- `[secure]`：是否使用 HTTPS 协议访问 OSS，默认值为true\r\n- `[cname]`：`endpoint`参数是否为自定义域名，默认值为false，若该值配置为true，请设置`endpoint`参数\r\n- `[sldEnable]`：是否使用二级域名方式访问 OSS，默认值为false\r\n- `[signVersion]`：签名版本，默认值为`ESignVersion.V4`，即签名版本4\r\n- `[isRequestPay]`：是否使用请求者付费模式，默认值为false，若该值配置为true，请求中将携带`x-oss-request-payer`请求头，且取值为`requester`\r\n- `[userAgent]`：自定义 User-Agent，该值将作为请求头`User-Agent`中的一部分进行发送\r\n- `[timeout]`：请求超时时间，单位：毫秒（ms），默认值为60000 ms，即60秒\r\n- `[disabledMD5]`：是否不计算 Content-MD5 值，默认值为false\r\n- `[proxy]`：HTTP 请求配置代理设置\r\n- `[retryMax]`：请求失败最大重试次数，默认值为0\r\n- `[requestErrorShouldRetry]`：请求失败是否重试判断方法，默认全部重试\r\n- `[amendTimeSkewed]`：修正时间偏差，单位：毫秒（ms），默认值为0\r\n- `[customRequestFunction]`：自定义请求方法\r\n- `[customSign]`：自定义签名方法，配置此参数后，除 POST 签名外的所有需要计算签名的请求都会通过此方法计算签名\r\n\r\n#### MCP Server 配置\r\n- `[transportType]`：通信类型，默认为标准输入/输出（stdio）\r\n- `[port]`：HTTP 服务器监听端口，仅在使用 Steamable HTTP 通信时有效，默认为 18081\r\n- `[tools]`：要启用的工具列表，默认全部启用\r\n- `[listToolsMaxKeysMaxValue]`：列举类工具`maxKeys`参数可设置的最大值（1-1000），默认为 100\r\n- `[listToolsDefaultMaxKeys]`：列举类工具`maxKeys`参数的默认值，默认等于`listToolsMaxKeysMaxValue`\r\n- `[httpServer]`：自定义 HTTP 服务器实例（仅在使用 Streamable HTTP 通信时有效）\r\n- `[logger]`：日志记录器实例\r\n- `[xmlContentText]`：工具请求成功后是否以原始 XML 字符串格式返回结果，默认为 false（即返回 JSON 字符串）\r\n- `[toolsRequestSuccessCallback]`：工具请求成功时的回调函数\r\n- `[toolsRequestErrorCallback]`：工具请求失败时的回调函数\r\n\r\n## 许可证\r\n\r\nMIT\r\n","readmeFilename":"README.md","_rev":"1-bb100450f8c6d182ab32bd5eca76d73b"}