@ama-sdk/mcp

中文文档
15.3.1发布于 2026/11/10BSD-3-Clause构建来源已验证近 30 天下载 3338

Experimental package -- MCP module to expose SDK_CONTEXT.md from installed packages to AI assistants

原始使用文档
文档目录14 节
  1. Purpose
  2. Configuration
  3. VS Code .vscode/mcp.json
  4. Usage
  5. CLI (for mcp.json)
  6. Programmatic (in custom MCP server)
  7. Available Tool
  8. Available Resources
  9. How It Works
  10. Package Resolution
  11. Troubleshooting
  12. Package Not Found
  13. No SDK_CONTEXT.md Found
  14. Generating SDK Context

@ama-sdk/mcp

MCP module to expose SDK_CONTEXT.md from installed packages to AI assistants.

Purpose

When SDKs are generated using @ama-sdk/schematics, they can include an SDK_CONTEXT.md file that describes:

  • Available API domains and operations
  • Models used by each domain
  • Guidelines for AI tools to avoid hallucinations

This MCP module automatically discovers and loads these context files from installed packages using Node.js's module resolution, then exposes them to AI assistants.

Configuration

VS Code .vscode/mcp.json

Configure SDK packages directly in your .vscode/mcp.json:

{
  "servers": {
    "sdk-context": {
      "command": "npx",
      "args": ["-y", "-p", "@ama-sdk/mcp", "ama-sdk-mcp", "--packages", "@my-scope/my-sdk-package", "@other-scope/other-sdk"]
    }
  }
}

Usage

CLI (for mcp.json)

# Specify packages with --packages flag
ama-sdk-mcp --packages @my-scope/my-sdk @other-scope/other-sdk

# Show help
ama-sdk-mcp --help

Programmatic (in custom MCP server)

import { registerSdkContextToolAndResources } from '@ama-sdk/mcp';

// With explicit packages
await registerSdkContextToolAndResources(server, {
  sdkPackages: ['@my-scope/my-sdk']
});

// Or reads from package.json sdkContext.packages automatically
await registerSdkContextToolAndResources(server);

Available Tool

get_sdk_context - Retrieve SDK context for configured packages

// List all configured SDKs with context
get_sdk_context()

// Get context for specific package
get_sdk_context({ packageName: "@my-scope/my-sdk-package" })

Available Resources

sdk-context://instructions - Usage guidelines for AI assistants

This resource provides instructions on how to use SDK context effectively to avoid hallucinations when implementing features. AI assistants should read this resource before using the get_sdk_context tool.

sdk-context://<package-name> - SDK context for each configured package

Each configured SDK package that has an SDK_CONTEXT.md file is exposed as a resource.

How It Works

  1. Reads sdkContext.packages from project's package.json or uses CLI arguments
  2. Uses Node.js require.resolve() to automatically locate packages
  3. Loads SDK_CONTEXT.md from each resolved package
  4. Registers each as an MCP resource
  5. Provides a tool for AI assistants to query SDK information

Package Resolution

The SDK automatically discovers packages using Node.js's require.resolve(). This means:

  • No manual path configuration needed - packages are found automatically
  • Works with workspaces - supports npm/yarn/pnpm workspace configurations
  • Flexible installation - works with local, global, or custom module paths
  • Error handling - clear error messages when packages aren't found

If a package isn't found, ensure:

  1. The package is installed (npm install <package-name>)
  2. The package name is spelled correctly
  3. The package has an SDK_CONTEXT.md file in its root

Security: The system validates package names to prevent path traversal attacks and only accepts valid npm package name patterns.

Troubleshooting

Package Not Found

Package "@my-scope/my-sdk" not found. Is it installed?

Solution: Install the package or verify the name in your configuration.

No SDK_CONTEXT.md Found

No SDK_CONTEXT.md found for @my-scope/my-sdk

Solution: Generate the context file using the command below.

Generating SDK Context

SDK maintainers can generate SDK_CONTEXT.md using:

cd /path/to/sdk-project
npx amasdk-update-sdk-context --interactive

版本与发布记录

@ama-sdk/mcp 共发布 234 个版本,首次发布于 2026/05/14;过去 12 个月发布了 234 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
15.3.1latest2026/11/10今天
15.4.0-prerelease.9prerelease2026/11/091 天前
15.4.0-prerelease.82026/11/073 天前
15.4.0-prerelease.72026/11/073 天前
15.3.0-rc.2rc2026/11/064 天前
15.4.0-prerelease.62026/11/064 天前

其他发布通道:v14-updated → 14.5.4,v15-updated → 15.1.3,rc → 15.3.0-rc.2,prerelease → 15.4.0-prerelease.9。

关于 @ama-sdk/mcp 的常见问题

@ama-sdk/mcp 是什么?

Experimental package -- MCP module to expose SDK_CONTEXT.md from installed packages to AI assistants

如何安装 @ama-sdk/mcp?

在项目目录运行 npm install @ama-sdk/mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ama-sdk-mcp、ama-sdk-mcp-start,可以用 npx ama-sdk-mcp 直接运行。

@ama-sdk/mcp 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/ama-sdk__mcp 是否存在。

@ama-sdk/mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^22.22.3 || ^24.15.0 || ^26.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@ama-sdk/mcp 可以商用吗?

@ama-sdk/mcp 使用 BSD-3-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括,不构成法律意见,请以许可原文为准。

@ama-sdk/mcp 的下载量有多少?

根据 npm 官方下载统计,@ama-sdk/mcp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,338 次,日均约 111 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ama-sdk/mcp 还在维护吗?

最新版本 15.3.1 发布于 2026/11/10(今天);至今共发布 234 个版本,其中过去 12 个月发布了 234 个;首次发布于 2026/05/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。