diff --git a/README.md b/README.md index 889adb5..60b2ddf 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,12 @@ This guide will help you set up a Model Context Protocol (MCP) server for KiCad. - [Project Structure](#project-structure) - [Installation Steps](#installation-steps) - [1. Set Up Your Python Environment](#1-set-up-your-python-environment) - - [2. Run the Server](#2-run-the-server) - - [3. Configure Claude Desktop](#3-configure-claude-desktop) - - [4. Restart Claude Desktop](#4-restart-claude-desktop) + - [2. Configure Your Environment](#2-configure-your-environment) + - [3. Run the Server](#3-run-the-server) + - [4. Configure an MCP Client](#4-configure-an-mcp-client) + - [5. Restart Your MCP Client](#5-restart-your-mcp-client) - [Understanding MCP Components](#understanding-mcp-components) + - [Resources vs Tools vs Prompts](#resources-vs-tools-vs-prompts) - [Features and Usage Guide](#features-and-usage-guide) - [Project Management](#project-management) - [PCB Design Analysis](#pcb-design-analysis) @@ -23,7 +25,15 @@ This guide will help you set up a Model Context Protocol (MCP) server for KiCad. - [PCB Visualization](#pcb-visualization) - [Templates and Prompts](#templates-and-prompts) - [Usage Examples](#usage-examples) + - [Example 1: Basic Project Workflow](#example-1-basic-project-workflow) + - [Example 2: Getting PCB Design Help](#example-2-getting-pcb-design-help) +- [Configuration Options](#configuration-options) + - [Key Configuration Options](#key-configuration-options) + - [Using Environment Variables Directly](#using-environment-variables-directly) + - [Using a .env File (Recommended)](#using-a-env-file-recommended) - [Development Guide](#development-guide) + - [Adding New Features](#adding-new-features) + - [Running Tests](#running-tests) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - [Future Development Ideas](#future-development-ideas) diff --git a/requirements.txt b/requirements.txt index c5a99e4..f0a753c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ mcp[cli] httpx +pytest