Skip to content

Commit 7732c81

Browse files
committed
Fix README toc
Signed-off-by: Mihai Criveti <[email protected]>
1 parent ab62d4d commit 7732c81

File tree

1 file changed

+76
-74
lines changed

1 file changed

+76
-74
lines changed

README.md

Lines changed: 76 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -31,80 +31,82 @@ ContextForge MCP Gateway is a feature-rich gateway, proxy and MCP Registry that
3131
## Table of Contents
3232

3333
<!-- vscode-markdown-toc -->
34-
* 1. [Table of Contents](#TableofContents)
35-
* 2. [🚀 Overview & Goals](#OverviewGoals)
36-
* 3. [Quick Start - PyPI](#QuickStart-PyPI)
37-
* 3.1. [1 - Install & run (copy-paste friendly)](#Installruncopy-pastefriendly)
38-
* 4. [Quick Start - Containers](#QuickStart-Containers)
39-
* 4.1. [🐳 Docker](#Docker)
40-
* 4.1.1. [1 - Minimum viable run](#Minimumviablerun)
41-
* 4.1.2. [2 - Persist the SQLite database](#PersisttheSQLitedatabase)
42-
* 4.1.3. [3 - Local tool discovery (host network)](#Localtooldiscoveryhostnetwork)
43-
* 4.2. [🦭 Podman (rootless-friendly)](#Podmanrootless-friendly)
44-
* 4.2.1. [1 - Basic run](#Basicrun)
45-
* 4.2.2. [2 - Persist SQLite](#PersistSQLite)
46-
* 4.2.3. [3 - Host networking (rootless)](#Hostnetworkingrootless)
47-
* 5. [Testing `mcpgateway.wrapper` by hand:](#Testingmcpgateway.wrapperbyhand:)
48-
* 5.1. [🧩 Running from an MCP Client (`mcpgateway.wrapper`)](#RunningfromanMCPClientmcpgateway.wrapper)
49-
* 5.1.1. [1 - Install <code>uv</code> (<code>uvx</code> is an alias it provides)](#Installcodeuvcodecodeuvxcodeisanaliasitprovides)
50-
* 5.1.2. [2 - Create an on-the-spot venv & run the wrapper](#Createanon-the-spotvenvrunthewrapper)
51-
* 5.1.3. [Claude Desktop JSON (runs through **uvx**)](#ClaudeDesktopJSONrunsthroughuvx)
52-
* 5.2. [🚀 Using with Claude Desktop (or any GUI MCP client)](#UsingwithClaudeDesktoporanyGUIMCPclient)
53-
* 6. [🚀 Quick Start: VS Code Dev Container](#QuickStart:VSCodeDevContainer)
54-
* 6.1. [1 - Clone & Open](#CloneOpen)
55-
* 6.2. [2 - First-Time Build (Automatic)](#First-TimeBuildAutomatic)
56-
* 7. [Quick Start (manual install)](#QuickStartmanualinstall)
57-
* 7.1. [Prerequisites](#Prerequisites)
58-
* 7.2. [One-liner (dev)](#One-linerdev)
59-
* 7.3. [Containerised (self-signed TLS)](#Containerisedself-signedTLS)
60-
* 7.4. [Smoke-test the API](#Smoke-testtheAPI)
61-
* 8. [Installation](#Installation)
62-
* 8.1. [Via Make](#ViaMake)
63-
* 8.2. [UV (alternative)](#UValternative)
64-
* 8.3. [pip (alternative)](#pipalternative)
65-
* 8.4. [Optional (PostgreSQL adapter)](#OptionalPostgreSQLadapter)
66-
* 8.4.1. [Quick Postgres container](#QuickPostgrescontainer)
67-
* 9. [Configuration (`.env` or env vars)](#Configuration.envorenvvars)
68-
* 9.1. [Basic](#Basic)
69-
* 9.2. [Authentication](#Authentication)
70-
* 9.3. [UI Features](#UIFeatures)
71-
* 9.4. [Security](#Security)
72-
* 9.5. [Logging](#Logging)
73-
* 9.6. [Transport](#Transport)
74-
* 9.7. [Federation](#Federation)
75-
* 9.8. [Resources](#Resources)
76-
* 9.9. [Tools](#Tools)
77-
* 9.10. [Prompts](#Prompts)
78-
* 9.11. [Health Checks](#HealthChecks)
79-
* 9.12. [Database](#Database)
80-
* 9.13. [Cache Backend](#CacheBackend)
81-
* 9.14. [Development](#Development)
82-
* 10. [Running](#Running)
83-
* 10.1. [Makefile](#Makefile)
84-
* 10.2. [Script helper](#Scripthelper)
85-
* 10.3. [Manual (Uvicorn)](#ManualUvicorn)
86-
* 11. [Authentication examples](#Authenticationexamples)
87-
* 12. [☁️ AWS / Azure / OpenShift](#AWSAzureOpenShift)
88-
* 13. [☁️ IBM Cloud Code Engine Deployment](#IBMCloudCodeEngineDeployment)
89-
* 13.1. [🔧 Prerequisites](#Prerequisites-1)
90-
* 13.2. [📦 Environment Variables](#EnvironmentVariables)
91-
* 13.3. [🚀 Make Targets](#MakeTargets)
92-
* 13.4. [📝 Example Workflow](#ExampleWorkflow)
93-
* 14. [API Endpoints](#APIEndpoints)
94-
* 15. [Testing](#Testing)
95-
* 16. [Project Structure](#ProjectStructure)
96-
* 17. [API Documentation](#APIDocumentation)
97-
* 18. [Makefile targets](#Makefiletargets)
98-
* 19. [🔍 Troubleshooting](#Troubleshooting)
99-
* 19.1. [Diagnose the listener](#Diagnosethelistener)
100-
* 19.2. [Why localhost fails on Windows](#WhylocalhostfailsonWindows)
101-
* 19.2.1. [Fix (Podman rootless)](#FixPodmanrootless)
102-
* 19.2.2. [Fix (Docker Desktop > 4.19)](#FixDockerDesktop4.19)
103-
* 20. [Contributing](#Contributing)
104-
* 21. [Changelog](#Changelog)
105-
* 22. [License](#License)
106-
* 23. [Core Authors and Maintainers](#CoreAuthorsandMaintainers)
107-
* 24. [Star History and Project Activity](#StarHistoryandProjectActivity)
34+
## Table of Contents
35+
36+
* 1. [Table of Contents](#table-of-contents)
37+
* 2. [🚀 Overview & Goals](#-overview--goals)
38+
* 3. [Quick Start - PyPI](#quick-start---pypi)
39+
* 3.1. [1 - Install & run (copy-paste friendly)](#1---install--run-copy-paste-friendly)
40+
* 4. [Quick Start - Containers](#quick-start---containers)
41+
* 4.1. [🐳 Docker](#-docker)
42+
* 4.1.1. [1 - Minimum viable run](#1---minimum-viable-run)
43+
* 4.1.2. [2 - Persist the SQLite database](#2---persist-the-sqlite-database)
44+
* 4.1.3. [3 - Local tool discovery (host network)](#3---local-tool-discovery-host-network)
45+
* 4.2. [🦭 Podman (rootless-friendly)](#-podman-rootless-friendly)
46+
* 4.2.1. [1 - Basic run](#1---basic-run)
47+
* 4.2.2. [2 - Persist SQLite](#2---persist-sqlite)
48+
* 4.2.3. [3 - Host networking (rootless)](#3---host-networking-rootless)
49+
* 5. [Testing `mcpgateway.wrapper` by hand](#testing-mcpgatewaywrapper-by-hand)
50+
* 5.1. [🧩 Running from an MCP Client (`mcpgateway.wrapper`)](#-running-from-an-mcp-client-mcpgatewaywrapper)
51+
* 5.1.1. [1 - Install `uv` (`uvx` is an alias it provides)](#1---install-uv-uvx-is-an-alias-it-provides)
52+
* 5.1.2. [2 - Create an on-the-spot venv & run the wrapper](#2---create-an-on-the-spot-venv--run-the-wrapper)
53+
* 5.1.3. [Claude Desktop JSON (runs through **uvx**)](#claude-desktop-json-runs-through-uvx)
54+
* 5.2. [🚀 Using with Claude Desktop (or any GUI MCP client)](#-using-with-claude-desktop-or-any-gui-mcp-client)
55+
* 6. [🚀 Quick Start: VS Code Dev Container](#-quick-start-vs-code-dev-container)
56+
* 6.1. [1 - Clone & Open](#1---clone--open)
57+
* 6.2. [2 - First-Time Build (Automatic)](#2---first-time-build-automatic)
58+
* 7. [Quick Start (manual install)](#quick-start-manual-install)
59+
* 7.1. [Prerequisites](#prerequisites)
60+
* 7.2. [One-liner (dev)](#one-liner-dev)
61+
* 7.3. [Containerised (self-signed TLS)](#containerised-self-signed-tls)
62+
* 7.4. [Smoke-test the API](#smoke-test-the-api)
63+
* 8. [Installation](#installation)
64+
* 8.1. [Via Make](#via-make)
65+
* 8.2. [UV (alternative)](#uv-alternative)
66+
* 8.3. [pip (alternative)](#pip-alternative)
67+
* 8.4. [Optional (PostgreSQL adapter)](#optional-postgresql-adapter)
68+
* 8.4.1. [Quick Postgres container](#quick-postgres-container)
69+
* 9. [Configuration (`.env` or env vars)](#configuration-env-or-env-vars)
70+
* 9.1. [Basic](#basic)
71+
* 9.2. [Authentication](#authentication)
72+
* 9.3. [UI Features](#ui-features)
73+
* 9.4. [Security](#security)
74+
* 9.5. [Logging](#logging)
75+
* 9.6. [Transport](#transport)
76+
* 9.7. [Federation](#federation)
77+
* 9.8. [Resources](#resources)
78+
* 9.9. [Tools](#tools)
79+
* 9.10. [Prompts](#prompts)
80+
* 9.11. [Health Checks](#health-checks)
81+
* 9.12. [Database](#database)
82+
* 9.13. [Cache Backend](#cache-backend)
83+
* 9.14. [Development](#development)
84+
* 10. [Running](#running)
85+
* 10.1. [Makefile](#makefile)
86+
* 10.2. [Script helper](#script-helper)
87+
* 10.3. [Manual (Uvicorn)](#manual-uvicorn)
88+
* 11. [Authentication examples](#authentication-examples)
89+
* 12. [☁️ AWS / Azure / OpenShift](#️-aws--azure--openshift)
90+
* 13. [☁️ IBM Cloud Code Engine Deployment](#️-ibm-cloud-code-engine-deployment)
91+
* 13.1. [🔧 Prerequisites](#-prerequisites-1)
92+
* 13.2. [📦 Environment Variables](#-environment-variables)
93+
* 13.3. [🚀 Make Targets](#-make-targets)
94+
* 13.4. [📝 Example Workflow](#-example-workflow)
95+
* 14. [API Endpoints](#api-endpoints)
96+
* 15. [Testing](#testing)
97+
* 16. [Project Structure](#project-structure)
98+
* 17. [API Documentation](#api-documentation)
99+
* 18. [Makefile targets](#makefile-targets)
100+
* 19. [🔍 Troubleshooting](#-troubleshooting)
101+
* 19.1. [Diagnose the listener](#diagnose-the-listener)
102+
* 19.2. [Why localhost fails on Windows](#why-localhost-fails-on-windows)
103+
* 19.2.1. [Fix (Podman rootless)](#fix-podman-rootless)
104+
* 19.2.2. [Fix (Docker Desktop > 4.19)](#fix-docker-desktop--419)
105+
* 20. [Contributing](#contributing)
106+
* 21. [Changelog](#changelog)
107+
* 22. [License](#license)
108+
* 23. [Core Authors and Maintainers](#core-authors-and-maintainers)
109+
* 24. [Star History and Project Activity](#star-history-and-project-activity)
108110

109111
<!-- vscode-markdown-toc-config
110112
numbering=true

0 commit comments

Comments
 (0)