CDK API

Provides offline CDK API references and integration tests for sample usage.

other

0

GitHub Stars

other

Language

6 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "konokenj-cdk-api-mcp-server": {
      "command": "uvx",
      "args": [
        "konokenj.cdk-api-mcp-server@latest"
      ]
    }
  }
}

You can provide AWS CDK API references to MCP clients and run offline documentation lookups by using a dedicated MCP server that serves module and file contents on demand. This server enables you to discover available CDK API modules, read module documents, and access file contents without leaving your environment.

How to use

To use this MCP server, configure your MCP client to connect through a local stdio runtime that executes the server package using the uvx runtime. The server exposes two core capabilities you’ll leverage: listing available modules within a package and reading documents or files for those modules. You can access these resources to build offline tooling, IDE integrations, or automated documentation pipelines.

How to install

Prerequisites you need before running the MCP server: install the uvx runtime to execute MCP servers, and ensure you have access to the package konokenj.cdk-api-mcp-server.

Follow these steps to install and run the MCP server locally:

# Step 1: Ensure uvx is installed and available in your PATH
# Step 2: Run the MCP server using the published package
uvx konokenj.cdk-api-mcp-server@latest

Note: If your workflow requires a specific version, replace @latest with the desired version tag. The server is designed to be used by MCP clients for offline access to CDK API modules and documents.

## Additional notes

Configuration is provided through an MCP JSON file that references the stdio-based MCP server. You specify the server command and arguments to start the runtime and connect to the server from your MCP client.

{ "mcpServers": { "cdk_api": { "command": "uvx", "args": ["konokenj.cdk-api-mcp-server@latest"] } } }


This configuration enables the MCP client to launch the server as a local process and communicate via stdio.

Security and licensing

The server and its usage are distributed under MIT license. Treat the server as you would any executable component that renders documentation and code references locally, and avoid exposing internal documents beyond what you intentionally share.

Available tools

list_resources

Return all registered static resource modules available under a package; used by MCP clients to discover what documents exist.

read_resource

Read a document or file within a module to present its contents to the MCP client.