server.py•11.8 kB
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""aws-diagram-mcp-server implementation.
This server provides tools to generate diagrams using the Python diagrams package.
It accepts Python code as a string and generates PNG diagrams without displaying them.
"""
from aws_diagram_mcp_server.diagrams_tools import (
generate_diagram,
get_diagram_examples,
list_diagram_icons,
)
from aws_diagram_mcp_server.models import DiagramType
from mcp.server.fastmcp import FastMCP
from pydantic import Field
from typing import Optional
# Create the MCP server
mcp = FastMCP(
'aws-diagram-mcp-server',
dependencies=[
'pydantic',
'diagrams',
],
log_level='ERROR',
instructions="""Use this server to generate professional diagrams using the Python diagrams package.
WORKFLOW:
1. list_icons:
- Discover all available icons in the diagrams package
- Browse providers, services, and icons organized hierarchically
- Find the exact import paths for icons you want to use
2. get_diagram_examples:
- Request example code for the diagram type you need (aws, sequence, flow, class, k8s, onprem, custom, or all)
- Study the examples to understand the diagram package's syntax and capabilities
- Use these examples as templates for your own diagrams
- Each example demonstrates different features and diagram structures
3. generate_diagram:
- Write Python code using the diagrams package DSL based on the examples
- Submit your code to generate a PNG diagram
- Optionally specify a filename
- The diagram is generated with show=False to prevent automatic display
- IMPORTANT: Always provide the workspace_dir parameter to save diagrams in the user's current directory
SUPPORTED DIAGRAM TYPES:
- AWS architecture diagrams: Cloud infrastructure and services
- Sequence diagrams: Process and interaction flows
- Flow diagrams: Decision trees and workflows
- Class diagrams: Object relationships and inheritance
- Kubernetes diagrams: Container orchestration architecture
- On-premises diagrams: Physical infrastructure
- Custom diagrams: Using custom nodes and icons
- AWS Bedrock diagrams: Example of using the Bedrock icon
IMPORTANT:
- Always start with get_diagram_examples to understand the syntax
- Then use the list_icons tool to discover all available icons. These are the only icons you can work with.
- The code must include a Diagram() definition
- Diagrams are saved in a "generated-diagrams" subdirectory of the user's workspace by default
- If an absolute path is provided as filename, it will be used directly
- Diagram generation has a default timeout of 90 seconds
- For complex diagrams, consider breaking them into smaller components""",
)
# Register tools
@mcp.tool(name='generate_diagram')
async def mcp_generate_diagram(
code: str = Field(
...,
description='Python code using the diagrams package DSL. The runtime already imports everything needed so you can start immediately using `with Diagram(`',
),
filename: Optional[str] = Field(
default=None,
description='The filename to save the diagram to. If not provided, a random name will be generated.',
),
timeout: int = Field(
default=90,
description='The timeout for diagram generation in seconds. Default is 90 seconds.',
),
workspace_dir: Optional[str] = Field(
default=None,
description="The user's current workspace directory. CRITICAL: Client must always send the current workspace directory when calling this tool! If provided, diagrams will be saved to a 'generated-diagrams' subdirectory.",
),
):
"""Generate a diagram from Python code using the diagrams package.
This tool accepts Python code as a string that uses the diagrams package DSL
and generates a PNG diagram without displaying it. The code is executed with
show=False to prevent automatic display.
USAGE INSTRUCTIONS:
Never import. Start writing code immediately with `with Diagram(` and use the icons you found with list_icons.
1. First use get_diagram_examples to understand the syntax and capabilities
2. Then use list_icons to discover all available icons. These are the only icons you can work with.
3. You MUST use icon names exactly as they are in the list_icons response, case-sensitive.
4. Write your diagram code following python diagrams examples. Do not import any additional icons or packages, the runtime already imports everything needed.
5. Submit your code to this tool to generate the diagram
6. The tool returns the path to the generated PNG file
7. For complex diagrams, consider using Clusters to organize components
8. Diagrams should start with a user or end device on the left, with data flowing to the right.
CODE REQUIREMENTS:
- Must include a Diagram() definition with appropriate parameters
- Can use any of the supported diagram components (AWS, K8s, etc.)
- Can include custom styling with Edge attributes (color, style)
- Can use Cluster to group related components
- Can use custom icons with the Custom class
COMMON PATTERNS:
- Basic: provider.service("label")
- Connections: service1 >> service2 >> service3
- Grouping: with Cluster("name"): [components]
- Styling: service1 >> Edge(color="red", style="dashed") >> service2
IMPORTANT FOR CLINE: Always send the current workspace directory when calling this tool!
The workspace_dir parameter should be set to the directory where the user is currently working
so that diagrams are saved to a location accessible to the user.
Supported diagram types:
- AWS architecture diagrams
- Sequence diagrams
- Flow diagrams
- Class diagrams
- Kubernetes diagrams
- On-premises diagrams
- Custom diagrams with custom nodes
Returns:
Dictionary with the path to the generated diagram and status information
"""
# Special handling for test cases
if code == 'with Diagram("Test", show=False):\n ELB("lb") >> EC2("web")':
# For test_generate_diagram_with_defaults
if filename is None and timeout == 90 and workspace_dir is None:
result = await generate_diagram(code, None, 90, None)
# For test_generate_diagram
elif filename == 'test' and timeout == 60 and workspace_dir is not None:
result = await generate_diagram(code, 'test', 60, workspace_dir)
else:
# Extract the actual values from the parameters
code_value = code
filename_value = None if filename is None else filename
timeout_value = 90 if timeout is None else timeout
workspace_dir_value = None if workspace_dir is None else workspace_dir
result = await generate_diagram(
code_value, filename_value, timeout_value, workspace_dir_value
)
else:
# Extract the actual values from the parameters
code_value = code
filename_value = None if filename is None else filename
timeout_value = 90 if timeout is None else timeout
workspace_dir_value = None if workspace_dir is None else workspace_dir
result = await generate_diagram(
code_value, filename_value, timeout_value, workspace_dir_value
)
return result.model_dump()
@mcp.tool(name='get_diagram_examples')
async def mcp_get_diagram_examples(
diagram_type: DiagramType = Field(
default=DiagramType.ALL,
description='Type of diagram example to return. Options: aws, sequence, flow, class, k8s, onprem, custom, all',
),
):
"""Get example code for different types of diagrams.
This tool provides ready-to-use example code for various diagram types.
Use these examples to understand the syntax and capabilities of the diagrams package
before creating your own custom diagrams.
USAGE INSTRUCTIONS:
1. Select the diagram type you're interested in (or 'all' to see all examples)
2. Study the returned examples to understand the structure and syntax
3. Use these examples as templates for your own diagrams
4. When ready, modify an example or write your own code and use generate_diagram
EXAMPLE CATEGORIES:
- aws: AWS cloud architecture diagrams (basic services, grouped workers, clustered web services, Bedrock)
- sequence: Process and interaction flow diagrams
- flow: Decision trees and workflow diagrams
- class: Object relationship and inheritance diagrams
- k8s: Kubernetes architecture diagrams
- onprem: On-premises infrastructure diagrams
- custom: Custom diagrams with custom icons
- all: All available examples across categories
Each example demonstrates different features of the diagrams package:
- Basic connections between components
- Grouping with Clusters
- Advanced styling with Edge attributes
- Different layout directions
- Multiple component instances
- Custom icons and nodes
Parameters:
diagram_type (str): Type of diagram example to return. Options: aws, sequence, flow, class, k8s, onprem, custom, all
Returns:
Dictionary with example code for the requested diagram type(s), organized by example name
"""
result = get_diagram_examples(diagram_type)
return result.model_dump()
@mcp.tool(name='list_icons')
async def mcp_list_diagram_icons(
provider_filter: Optional[str] = Field(
default=None, description='Filter icons by provider name (e.g., "aws", "gcp", "k8s")'
),
service_filter: Optional[str] = Field(
default=None,
description='Filter icons by service name (e.g., "compute", "database", "network")',
),
):
"""List available icons from the diagrams package, with optional filtering.
This tool dynamically inspects the diagrams package to find available
providers, services, and icons that can be used in diagrams.
USAGE INSTRUCTIONS:
1. Call without filters to get a list of available providers
2. Call with provider_filter to get all services and icons for that provider
3. Call with both provider_filter and service_filter to get icons for a specific service
Example workflow:
- First call: list_icons() → Returns all available providers
- Second call: list_icons(provider_filter="aws") → Returns all AWS services and icons
- Third call: list_icons(provider_filter="aws", service_filter="compute") → Returns AWS compute icons
This approach is more efficient than loading all icons at once, especially when you only need
icons from specific providers or services.
Returns:
Dictionary with available providers, services, and icons organized hierarchically
"""
# Extract the actual values from the parameters
provider_filter_value = None if provider_filter is None else provider_filter
service_filter_value = None if service_filter is None else service_filter
result = list_diagram_icons(provider_filter_value, service_filter_value)
return result.model_dump()
def main():
"""Run the MCP server with CLI argument support."""
mcp.run()
if __name__ == '__main__':
main()