From 53ceddab3953a715c3f227eb3a6bd06ddac5f7e9 Mon Sep 17 00:00:00 2001 From: "den (work)" <53200638+localden@users.noreply.github.com> Date: Mon, 24 Mar 2025 12:35:57 -0700 Subject: [PATCH 1/8] Docs configuration --- .github/workflows/docs.yml | 44 ++++++++++++++++++++++++++++++++++ .gitignore | 4 ++++ docs/docfx.json | 48 +++++++++++++++++++++++++++++++++++++ docs/images/favicon.ico | Bin 0 -> 15406 bytes docs/images/logo.png | Bin 0 -> 1348 bytes docs/index.md | 9 +++++++ docs/toc.yml | 4 ++++ 7 files changed, 109 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/docfx.json create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/logo.png create mode 100644 docs/index.md create mode 100644 docs/toc.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..a19ddb72a --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,44 @@ +on: + push: + branches: + - main + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + actions: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + publish-docs: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: .NET Setup + uses: actions/setup-dotnet@v3 + with: + dotnet-version: 9.x + + - run: dotnet tool update -g docfx + + - run: docfx docs/docfx.json + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/_site' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 1dc1beb8c..3fce64294 100644 --- a/.gitignore +++ b/.gitignore @@ -73,3 +73,7 @@ _NCrunch_* nCrunchTemp_* *.orig + +# Auto-generated documentation +docs/_site +docs/api \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 000000000..a16504a38 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,48 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", + "metadata": [ + { + "src": [ + { + "src": "../src", + "files": [ + "**/*.csproj" + ] + } + ], + "dest": "api" + } + ], + "build": { + "content": [ + { + "files": [ + "**/*.{md,yml}" + ], + "exclude": [ + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "output": "_site", + "template": [ + "default", + "modern" + ], + "globalMetadata": { + "_appName": "MCP .NET SDK", + "_appTitle": "MCP .NET SDK", + "_enableSearch": true, + "pdf": true, + "_appLogoPath": "images/logo.png", + "_appFaviconPath": "images/favicon.ico" + } + } +} \ No newline at end of file diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8e345d1fd9050e75198bc028f1cf651934eb9a89 GIT binary patch literal 15406 zcmeI3XNVL_5XaY?^~{Rtj2y-j6Xt*kOdk}(2QfzkF`*(xRLmgeoG|AsA}U7A2{S6@ zoO7(Vzkc@6w>Nt`H@kPY$9o0q%*{-9{j00Gs=B)Mcv5&$c_Jb_-fN_%cWRHPs>kDr zjQscSsO%okQtz|q=)dnvc|0d_dpuFzZ@f*sE&hG(z1Wfjpc^-C$dDmJ0(@ov`p%s@ zl0ScbnL2f<{RaV_PMS1H>ej6*fByUl@TL9hM~@y!v0}w!*sx)a`?!Dqz6=^PNIG}! zEW3B_7XEhH$BP#)l)T-$cbAD1CrX|?d1TtOX^#7tGiQ!8Yt~FoojN5;mMoEL*RDyv zeE9GiEsIqjc%gGJpPjdH(#lrbnV(zMvopXIdkTejT<+{YVWU)#fulq%9SfsyI#F|$-#pMZQJUHCJx3C zJ6gJQsnoAuUw;zts{82Er;m&qH%{^1vSmxacIF4nzX1aVNVjg?W^u;h+4G#W0AQ-@kv$)~#FBdHix)2nwy!B6F~EmBC42VlmYj@t$&w{y*REX}f+Pe6 z^hwU3b(}3*Hi?RglC){ls%I%uq)@R{g9tSSd@8)*GiAyY`TqU8V)gpBo+qZJ_=1p~vUb=MYVvB+NP>)$K^MZVUevTeJs(4nfUR_eA zOew^D2n^&7dW_6*2nB{5IdZ7Jj~_p-`1S1B)8Z9s4Bx(eQ+b|Z^!J|z4H_tZj3M;% z=TB+Zu3ds)K-bu{naiwOw@&d&l`562UAs0U7|8SNsAI>DidUL6X)FxPKW*p1Vj%Cw zPUz?A)vK`}F#gS(H;;wk$B!Sd z;=~C%76G3*#c=xcY1J3`AiP;~vnITE?_NM2fj)=}13o!ZrcA;b8|v4upW?6MW}v>E zzW0ZL_P>7pQr&#|^hxO)`E`tP+P{`}a$kGG!!Px^ywdRF7}!)TyO-@#1Rl&b0HSwk5Dr^EGoZ zFcYV!CuPWxA%;B2fsS;&1zD2PmTuj;C8bK0vM_?Xef#!m?|uFH^=i+cM~@z&>&wW- zI+C@tuMCOpm+%*D+qSi^Gq%(`sViuI&J~>GoJEQhvA#tH^k7nA+Y&XH!i5VfOw@WO zOqgK7VXaK2^Hh;iR3Zx;mnM#bz(!zU7m9#@6m)Fs1f_hU}sCdGK4zD z`NNMtGS^qk3uMrG2p3ygwQ7}BlVV-MSrZ7G=X?(5mb49EXVeI_4A|24?b~DNA=I`6 z7X0(GXV0_=Sl0^|E=Zw5g%n2CQf93leCWYf247n`d-iNB8A54GteNl=*fDEYvrdC- z>~H8XCib$Yrq_eWfF3x1r@yhYCG_CNFR|x>ua1jawQ6PY=3E*0Oc~IP$(u7|%wH{o zQ(JQ5m)Nu5OqZ@_+sVOxmU$ik8TRhoYkkUG#7^}25XPCkWOHvbl(s~zj+{{IlYKt? zwLd~O&I;-MZQ2n#kwNPLd@EM0Q0M-1zvMj$VM~nH=FOX}F(qH&tYch+&p-xWJ(#wH zEXd%i2RF84=a-n%+IPKq^G3>-FK_8!-n@Bn!B_9l17q$hgK10X;n1N&F=Svqa5h7e zTU#PGzxQ`<3LOwHwXTN`AFjKP^BRmTA%mXN$l$~;F{g=x_-58a?D;_8(EHoSFm~+N zIB}aV-P)2{zr>kK@mfZLyUoiM%_SSXYMf_whD83Yo zEjjT^ubgy z-^qM-OQE(U;-mH}T*+O)%+-93A0%#S{kX+XyHME@{cv`N^@@qryl20Fb%8!-5)5v$ zEw)5G+&4ZriE*s+bu8z+q?u2ZD_2fx*RCy1n>Ll+y?ZNLB3}r`W=!1Xy<1zVTD7XM zc86Fumn~b?8h_RU%v<*Nb^I`ShWZ{E(1UNjWai%3EV%}GH9my1bJXsj4{ld z_a?u@PBd<=)c?)81v$^afdi9#U((Jmv4_O}jUw*_^URqu)mc%qRvH-@DXg!k44ofy`glX(f`u%tWsIx;Y9 z?C1WI$O@D@6yOu$`v3p`w{PD*di3b|^XET){J4JodRJFhP*9MirKPK@YfetijvYI` ze*OCI-@nb9HveYq~8@#=}*REZA>eQ(N2M#neG}PDEfB*jd@87@c*ROx_ zSZQ2wZ z9Q@_Wm+b89qeqX*$;tWn_&k36`19w_fByVAeE6`4h=`w`-<>;mCQO(hD=Qlt8=IDv z*4o;7&aTU*=2#Ki5}w}1QgEj>N`?Af!I zE?rVmQkpbr(*FJX_4W0Oi;I(!lc!9X^6S^H6DLkgojP^(>eU}Ve!Owx#^lM9dwY8q zE?n5z+1cOU@9F8;)6;Y7)~z*b*1UW7?!tu&(b3WF?(RuRNo{Ry8#iv8GiT1yrAyzx ze{X1LC?q7*+}yln%a$`|&Tw#WJb3WHwmKW>pcVGK%2~@K!HNrE^(^HFq1IS@zkYZ$IU<9(f zfLI#J2Bj?xMrN=$6Oe7l$iyH3q@#d1vz-Mjo&{usz)UR`h8Msj2&2&~WdKS|U}sjH>LQ-Ev`U;>)U1XdYjX#r$Gbr~8MfMln5=-AlbLxmsu|@ouk^b#GdJhUXcnPiz$on z9ubY@N7PyhkC^nuJ)3G#@by+Hv**1XDc{(9G>826~&XFPZ+vU0UxgTABKz280j-rCZv z_e6ef{3)z`tV&bi*Ug%CZ^^SJdQrWTX71FF-=8||>ATlb*&8}**UmCZ`=6}yc%Hhr z&hJeN>eJu9+ONB$e#3%muM&QH{=0N#mFRnwmoX3ZgMGKm|Fc%?^@WW8lS8t Date: Mon, 24 Mar 2025 12:58:08 -0700 Subject: [PATCH 2/8] Update docs/index.md Co-authored-by: Eirik Tsarpalis --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index fdf0ef7f8..cf650495b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,6 @@ _layout: landing # Model Context Protocol (MCP) .NET SDK -Welcome to the API documentation for the MCP .NET SDK. [Explore the API](https://aka.ms/mcp/dotnet). +Welcome to the API documentation for the MCP C# SDK. [Explore the API](https://aka.ms/mcp/dotnet). For how-to guides, tutorials, and additional guidance, refer to the [official MCP documentation](https://modelcontextprotocol.io/). From c19de5c00f0ecbb72ef4459c6933dbde95d62681 Mon Sep 17 00:00:00 2001 From: "den (work)" <53200638+localden@users.noreply.github.com> Date: Mon, 24 Mar 2025 15:31:00 -0700 Subject: [PATCH 3/8] Update the configuration --- .github/workflows/docs.yml | 6 +++--- docs/docfx.json | 2 +- docs/images/logo.png | Bin 1348 -> 0 bytes docs/images/mcp.svg | 12 ++++++++++++ 4 files changed, 16 insertions(+), 4 deletions(-) delete mode 100644 docs/images/logo.png create mode 100644 docs/images/mcp.svg diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a19ddb72a..a51d36a35 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,7 +1,7 @@ on: - push: - branches: - - main + release: + types: [published] + workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: diff --git a/docs/docfx.json b/docs/docfx.json index a16504a38..b47daf2cf 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -41,7 +41,7 @@ "_appTitle": "MCP .NET SDK", "_enableSearch": true, "pdf": true, - "_appLogoPath": "images/logo.png", + "_appLogoPath": "images/mcp.svg", "_appFaviconPath": "images/favicon.ico" } } diff --git a/docs/images/logo.png b/docs/images/logo.png deleted file mode 100644 index e37bfa8c4fc76da068c4e75b1aca1fae86073ac0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1348 zcmeAS@N?(olHy`uVBq!ia0vp^Y9P$P3?%12mYf5m7>k44ofy`glX(f`u%tWsIx;Y9 z?C1WI$O@D@6yOu$`v3p`w{PD*di3b|^XET){J4JodRJFhP*9MirKPK@YfetijvYI` ze*OCI-@nb9HveYq~8@#=}*REZA>eQ(N2M#neG}PDEfB*jd@87@c*ROx_ zSZQ2wZ z9Q@_Wm+b89qeqX*$;tWn_&k36`19w_fByVAeE6`4h=`w`-<>;mCQO(hD=Qlt8=IDv z*4o;7&aTU*=2#Ki5}w}1QgEj>N`?Af!I zE?rVmQkpbr(*FJX_4W0Oi;I(!lc!9X^6S^H6DLkgojP^(>eU}Ve!Owx#^lM9dwY8q zE?n5z+1cOU@9F8;)6;Y7)~z*b*1UW7?!tu&(b3WF?(RuRNo{Ry8#iv8GiT1yrAyzx ze{X1LC?q7*+}yln%a$`|&Tw#WJb3WHwmKW>pcVGK%2~@K!HNrE^(^HFq1IS@zkYZ$IU<9(f zfLI#J2Bj?xMrN=$6Oe7l$iyH3q@#d1vz-Mjo&{usz)UR`h8Msj2&2&~WdKS|U}sjH>LQ-Ev`U;>)U1XdYjX#r$Gbr~8MfMln5=-AlbLxmsu|@ouk^b#GdJhUXcnPiz$on z9ubY@N7PyhkC^nuJ)3G#@by+Hv**1XDc{(9G>826~&XFPZ+vU0UxgTABKz280j-rCZv z_e6ef{3)z`tV&bi*Ug%CZ^^SJdQrWTX71FF-=8||>ATlb*&8}**UmCZ`=6}yc%Hhr z&hJeN>eJu9+ONB$e#3%muM&QH{=0N#mFRnwmoX3ZgMGKm|Fc%?^@WW8lS8t + + + + + + + + + + + From 350d4b15614b78a6298fcb56ad19b627acad50d6 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <53200638+localden@users.noreply.github.com> Date: Mon, 24 Mar 2025 15:31:36 -0700 Subject: [PATCH 4/8] Update docs/docfx.json Co-authored-by: Eirik Tsarpalis --- docs/docfx.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docfx.json b/docs/docfx.json index b47daf2cf..dc8f815a1 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -37,8 +37,8 @@ "modern" ], "globalMetadata": { - "_appName": "MCP .NET SDK", - "_appTitle": "MCP .NET SDK", + "_appName": "MCP C# SDK", + "_appTitle": "MCP C# SDK", "_enableSearch": true, "pdf": true, "_appLogoPath": "images/mcp.svg", From bac970c6fd1e8940cb8ed24664b11e1672aab387 Mon Sep 17 00:00:00 2001 From: "den (work)" <53200638+localden@users.noreply.github.com> Date: Mon, 24 Mar 2025 16:12:04 -0700 Subject: [PATCH 5/8] Update config --- .github/workflows/docs.yml | 8 ++++++-- docs/dotnet-tools.json | 12 ++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 docs/dotnet-tools.json diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a51d36a35..ee0d57a51 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,9 +30,13 @@ jobs: with: dotnet-version: 9.x - - run: dotnet tool update -g docfx + - name: Restore .NET tools + run: dotnet tool restore + working-directory: ./docs - - run: docfx docs/docfx.json + - name: Generate documentation + working-directory: ./docs + run: dotnet docfx docfx.json - name: Upload Pages artifact uses: actions/upload-pages-artifact@v3 diff --git a/docs/dotnet-tools.json b/docs/dotnet-tools.json new file mode 100644 index 000000000..5648e1fd7 --- /dev/null +++ b/docs/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "docfx": { + "version": "2.78.3", + "commands": [ + "docfx" + ] + } + } +} \ No newline at end of file From a7b80d7d9f8a438edc61161884b0babba225d89a Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Tue, 25 Mar 2025 12:30:16 +0000 Subject: [PATCH 6/8] Update icons, use Makefile, remove warnings --- .config/dotnet-tools.json | 13 ++++++ .github/workflows/docs.yml | 10 ++--- Makefile | 38 +++++++++++++++++ docs/docfx.json | 10 ++--- docs/dotnet-tools.json | 12 ------ docs/images/favicon.ico | Bin 15406 -> 33310 bytes docs/images/mcp.svg | 84 ++++++++++++++++++++++++++++++++----- docs/index.md | 18 +++++++- docs/toc.yml | 7 ++-- 9 files changed, 152 insertions(+), 40 deletions(-) create mode 100644 .config/dotnet-tools.json create mode 100644 Makefile delete mode 100644 docs/dotnet-tools.json diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 000000000..d32441dbf --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,13 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "docfx": { + "version": "2.78.3", + "commands": [ + "docfx" + ], + "rollForward": false + } + } +} \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ee0d57a51..65a3c4c35 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -26,22 +26,18 @@ jobs: uses: actions/checkout@v3 - name: .NET Setup - uses: actions/setup-dotnet@v3 + uses: actions/setup-dotnet@v4 with: dotnet-version: 9.x - - name: Restore .NET tools - run: dotnet tool restore - working-directory: ./docs - - name: Generate documentation working-directory: ./docs - run: dotnet docfx docfx.json + run: make generate-docs - name: Upload Pages artifact uses: actions/upload-pages-artifact@v3 with: - path: 'docs/_site' + path: 'artifacts/_site' - name: Deploy to GitHub Pages id: deployment diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..c2a0a012f --- /dev/null +++ b/Makefile @@ -0,0 +1,38 @@ +SOURCE_DIRECTORY := $(dir $(realpath $(lastword $(MAKEFILE_LIST)))) +ARTIFACT_PATH := $(SOURCE_DIRECTORY)artifacts +DOCS_PATH := $(SOURCE_DIRECTORY)docs +CONFIGURATION ?= Release + +clean: + dotnet clean + rm -rf $(ARTIFACT_PATH)/* + rm -rf $(DOCS_PATH)/api + +restore: + dotnet tool restore + dotnet restore + +build: restore + dotnet build --no-restore --configuration $(CONFIGURATION) + +test: build + dotnet test \ + --no-build \ + --configuration $(CONFIGURATION) \ + --filter '(Execution!=Manual)' \ + --blame \ + --diag "$(ARTIFACT_PATH)/diag.txt" \ + --logger "trx" \ + --collect "Code Coverage;Format=cobertura" \ + --results-directory $(ARTIFACT_PATH)/test-results \ + -- \ + RunConfiguration.CollectSourceInformation=true + +generate-docs: clean restore + dotnet build --no-restore --configuration Release + dotnet docfx $(DOCS_PATH)/docfx.json + +serve-docs: generate-docs + dotnet docfx serve $(ARTIFACT_PATH)/_site --port 8080 + +.DEFAULT_GOAL := build \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json index dc8f815a1..6b4feb833 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -10,7 +10,7 @@ ] } ], - "dest": "api" + "output": "api" } ], "build": { @@ -31,7 +31,7 @@ ] } ], - "output": "_site", + "output": "../artifacts/_site", "template": [ "default", "modern" @@ -39,10 +39,10 @@ "globalMetadata": { "_appName": "MCP C# SDK", "_appTitle": "MCP C# SDK", - "_enableSearch": true, - "pdf": true, "_appLogoPath": "images/mcp.svg", - "_appFaviconPath": "images/favicon.ico" + "_appFaviconPath": "images/favicon.ico", + "_enableSearch": true, + "pdf": false } } } \ No newline at end of file diff --git a/docs/dotnet-tools.json b/docs/dotnet-tools.json deleted file mode 100644 index 5648e1fd7..000000000 --- a/docs/dotnet-tools.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "version": 1, - "isRoot": true, - "tools": { - "docfx": { - "version": "2.78.3", - "commands": [ - "docfx" - ] - } - } -} \ No newline at end of file diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico index 8e345d1fd9050e75198bc028f1cf651934eb9a89..7b23c7bbcb5dc05ef91e0ce51fbdf96ca51416f7 100644 GIT binary patch literal 33310 zcmeI43A9#K6~`|sim8Dj;DGupa|lr^b4DKuXqq{NA*4YnYMPnQJAjXFe)W!{9ZJa_}ddvsuYO*bn7vXpq2(nx8FM!&Z4Vsd&Mg1HCcY+t+ z#x@kh+R$7a3SWgkLMW_?WqKS#Xl-~~^o-{6%djuRB-X}QDvpQ8U<&L6mBhF4X(|qf zaUehB6}2HB{1hgEbXGe>WCJSy5H5k8V-IRj*lH4Wru|3KzS6Rw7XR!`BL~!?p-3Cr zCf|kIB4wS;8kV;GPr~&(+gRlJ-;(!6o!VA+XTpEs93|=?tJ3Bys8t{9(AEg}CJcsd zpgw*B>f=19R`%n;=Rxflw-DDp-`PIeXhY-pIP4EwgWetQ!6VQQI@5=ZquSjbP6Wv) z2>YmJJbq0(uc$%fFChQ?QVFEmK0dbm@n!#>&A)1M3)mFiPSe%)As=haj|R!+un6u4 zy}OF`aWv0(S(k*yO}@20#uEPk?gP!!SRbkzj>lZ`UWXpwMf2`qQ2oQxf^metk2cb8 zfqXX;B-Y1+#JhoXSGndzDAo3%HTd(ivGIgze?XcJ1I_KwS2};Z4;qi&;C*!!X_JkK z{2La)%8(^R`*@UwZUU{zB`_2^l2{+|t&NA~m3$yyJPXoW`_e$jE0y{5TY3w9l#i1K|mH6WXA&qPeRvl)i@cZ|&o?lwE1;csLj|#uY{9 zq&8@WZf52xB+l!Za>Yz1tBD@Ilv+;N0 z{(V_59WHTw>OHMH_0lv?XCi+ltF;b#hsa*7@9%=n=8`_}E3h)1$4qLe!;LhmKD56| zdcuHZu_V#0`)3f-;oE7x$~v!Cw;+U*Tq zZY807|((D}&Z5F+YFXXKG-rgWGO$`?h);#8iA$#gQ+ zp4OJvVMdz&F5#C!QjHGk*V^A~Su6klkJ{8Z+3J`MI`7X+^R?b}uaT&JY%Ibv!Pl47 zUjEM=1Zsbh%k$AJ9klme19~>}LrjNoKJ1ouV(aqSG#v|Ssl#P-@DgmBb|kxHgZx=Z zvUDgq7QPSND;@{+ulGquA{}Od>iaoaNr(AqeLZs}tOk-z;P;?>`J)%)kQnGaLeXK#^8BqU+`+^$9LmiH#U9Aa8f3SJ}AL7!b9wHrVua=#!fc8P{&r0h( zwinb>WbEU0*0t@O&DErM@7m)Q z!kaLx_~T7|Lb|^SHkY-pl|@3`_0Bt}B+7plJ-y$h`;jHlU3w=Jz3> z?~S@Y>#RK=bp9R#-N8#M*{~Ig-4A|$3FGr9-_;vHycKNN5k11YMX0-_mr(bx7P6r) zy66mS`YF`Ca4hJaG79t!>I1Mky1R`AFU=Z<3sJ)K(wRVd$7CNeb3C({K0Ij(m5xZ-n?Bu3Ys#6O_l2d2G;F)oUCM3zX8|M3{}^gR-n-Gi}g0 zMc?vGt|nsopJSOh!e-f^Gw#YxKb=oZ|4A-CPqdLX=w37dHgk&gAny0PaDBL{nbABp z)M`zKO8kHf^S#!0->^c?wANHdduz2eWXk!dB z!t`&qf+mD{YzWo*F&U=2?i;Ix6&jq5+3@)c9gZR2znjj_sMqN1&<5R`u7@LF7)bBi z!Thf98CVxuMMk2C-xs~EVO-zcw{I22ogTXo*M1)A>(lpA{weoNt3|t`kmil%&tsr- zz(3#@@I~`+o@KkfHSV0Zk&@Qax2T!m=e*+jp79k}(d7yZjM=WU;)*T@VxZ2z z-hPdHSFl}U`=>5!yX=28u>WLbb|G1St$yy$Al;SD?N$|fOW`M=`@FsfR(i*keI5+L zzS*F2tbe!r_(IA~f*uf)GWtOGINjC#cXw}dEdB)bw~0A`yfXP|F z-AU+ghz9!1G+vDlPT<+t8L1g}raRHa+kZh|qxLQX<)b^Pp@# z2+uuwuZQ<_{Y_{1ozr}93T2^G;{)w8u|2Uf_r~>Ub5GE_I!knJHCrqU*MOdt53=S# zEBatC`Yr<5q`TSxh>6BZ?>w_zp`P0jLg`1w>)`8Jyxwb}=x?ak26{eEI?D%RgSxUw zW4!}}(o7$W4wb2pzKk*(8w<01pl=!1Me1kypf7ccu7#T-?dzPVzyFL$Y(LN*w05j= zBu_d%3TC^7Sw2{ky7xuuXZfI-c~H~`-;d}snY_Fr9UlR+-9q_b>qsNL$kScd>RBis z>=>zEbRHBvBWYgF3G|s4(W6pU*?llPuwP@MKMN}&MSY+%&s?zaw=ioh6rBfp=VYyg zcFMeH&MXGgL1EUnCjVR*FN+U;7b;FVJfj~SsgozG3_h3cgtWI^@%Erj(PU8{)cd_qN&krydixiXUZc_jIm^o6gDtS-4e<8sdt0q! z0~*RYBh})3ARp_U;q|w8N8cDf$#aiIo^2_ z&Gdn6(>UJ_55iI~dwr;LUvH?FG{Og2cV};BEWQAvx2l)nuHAb3ppCw=#y4iS^8NsQ zpixq9ALu(qmaUer?_l@9{*5v^=%=U;D%}^tZ!Wvgm)U8d?zy_xo&+O7-|d<$(xJ$^ zG0O+j14FcjncWs{7u0E$WY!r;zkv^oC>is?WkEgN70qr7V{HYGH7!}qJh&~j@qWVo zf#yTfGP7M_BlovJom|PHK2W3jo)(j-WO~~d#45F5UNt@l&Com#-+z~em0CDm$p_na zp!cSf>kQ||{yoy+`=NtonqHjcgGFfeJ@|N_;p(K1gO|YDuK1NuM#=JlY+3?$!wql; zybYnPg%`VMmqbY!nDpF@3}D^?^KiZS{-n%M8x hX8S{wkAQBlqRNICHU=ib#V`rRfxhK@Bz5$_{{STx3orlx literal 15406 zcmeI3XNVL_5XaY?^~{Rtj2y-j6Xt*kOdk}(2QfzkF`*(xRLmgeoG|AsA}U7A2{S6@ zoO7(Vzkc@6w>Nt`H@kPY$9o0q%*{-9{j00Gs=B)Mcv5&$c_Jb_-fN_%cWRHPs>kDr zjQscSsO%okQtz|q=)dnvc|0d_dpuFzZ@f*sE&hG(z1Wfjpc^-C$dDmJ0(@ov`p%s@ zl0ScbnL2f<{RaV_PMS1H>ej6*fByUl@TL9hM~@y!v0}w!*sx)a`?!Dqz6=^PNIG}! zEW3B_7XEhH$BP#)l)T-$cbAD1CrX|?d1TtOX^#7tGiQ!8Yt~FoojN5;mMoEL*RDyv zeE9GiEsIqjc%gGJpPjdH(#lrbnV(zMvopXIdkTejT<+{YVWU)#fulq%9SfsyI#F|$-#pMZQJUHCJx3C zJ6gJQsnoAuUw;zts{82Er;m&qH%{^1vSmxacIF4nzX1aVNVjg?W^u;h+4G#W0AQ-@kv$)~#FBdHix)2nwy!B6F~EmBC42VlmYj@t$&w{y*REX}f+Pe6 z^hwU3b(}3*Hi?RglC){ls%I%uq)@R{g9tSSd@8)*GiAyY`TqU8V)gpBo+qZJ_=1p~vUb=MYVvB+NP>)$K^MZVUevTeJs(4nfUR_eA zOew^D2n^&7dW_6*2nB{5IdZ7Jj~_p-`1S1B)8Z9s4Bx(eQ+b|Z^!J|z4H_tZj3M;% z=TB+Zu3ds)K-bu{naiwOw@&d&l`562UAs0U7|8SNsAI>DidUL6X)FxPKW*p1Vj%Cw zPUz?A)vK`}F#gS(H;;wk$B!Sd z;=~C%76G3*#c=xcY1J3`AiP;~vnITE?_NM2fj)=}13o!ZrcA;b8|v4upW?6MW}v>E zzW0ZL_P>7pQr&#|^hxO)`E`tP+P{`}a$kGG!!Px^ywdRF7}!)TyO-@#1Rl&b0HSwk5Dr^EGoZ zFcYV!CuPWxA%;B2fsS;&1zD2PmTuj;C8bK0vM_?Xef#!m?|uFH^=i+cM~@z&>&wW- zI+C@tuMCOpm+%*D+qSi^Gq%(`sViuI&J~>GoJEQhvA#tH^k7nA+Y&XH!i5VfOw@WO zOqgK7VXaK2^Hh;iR3Zx;mnM#bz(!zU7m9#@6m)Fs1f_hU}sCdGK4zD z`NNMtGS^qk3uMrG2p3ygwQ7}BlVV-MSrZ7G=X?(5mb49EXVeI_4A|24?b~DNA=I`6 z7X0(GXV0_=Sl0^|E=Zw5g%n2CQf93leCWYf247n`d-iNB8A54GteNl=*fDEYvrdC- z>~H8XCib$Yrq_eWfF3x1r@yhYCG_CNFR|x>ua1jawQ6PY=3E*0Oc~IP$(u7|%wH{o zQ(JQ5m)Nu5OqZ@_+sVOxmU$ik8TRhoYkkUG#7^}25XPCkWOHvbl(s~zj+{{IlYKt? zwLd~O&I;-MZQ2n#kwNPLd@EM0Q0M-1zvMj$VM~nH=FOX}F(qH&tYch+&p-xWJ(#wH zEXd%i2RF84=a-n%+IPKq^G3>-FK_8!-n@Bn!B_9l17q$hgK10X;n1N&F=Svqa5h7e zTU#PGzxQ`<3LOwHwXTN`AFjKP^BRmTA%mXN$l$~;F{g=x_-58a?D;_8(EHoSFm~+N zIB}aV-P)2{zr>kK@mfZLyUoiM%_SSXYMf_whD83Yo zEjjT^ubgy z-^qM-OQE(U;-mH}T*+O)%+-93A0%#S{kX+XyHME@{cv`N^@@qryl20Fb%8!-5)5v$ zEw)5G+&4ZriE*s+bu8z+q?u2ZD_2fx*RCy1n>Ll+y?ZNLB3}r`W=!1Xy<1zVTD7XM zc86Fumn~b?8h_RU%v<*Nb^I`ShWZ{E(1UNjWai%3EV%}GH9my1bJXsj4{ld z_a?u@PBd<=)c?)81v$^afdi9#U((Jmv4_O}jUw*_^URqu)mc%qRvH-@DXg! - - - - - - - - - - + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index cf650495b..92c2ac409 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,8 +2,22 @@ _layout: landing --- -# Model Context Protocol (MCP) .NET SDK +# Overview -Welcome to the API documentation for the MCP C# SDK. [Explore the API](https://aka.ms/mcp/dotnet). +The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. Please visit our [API documentation](api/ModelContextProtocol.yml) for more details on available functionality. + +## About MCP + +The Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It enables secure integration between LLMs and various data sources and tools. + +For more information about MCP: + +- [Official Documentation](https://modelcontextprotocol.io/) +- [Protocol Specification](https://spec.modelcontextprotocol.io/) +- [GitHub Organization](https://github.com/modelcontextprotocol) For how-to guides, tutorials, and additional guidance, refer to the [official MCP documentation](https://modelcontextprotocol.io/). + +## License + +This project is licensed under the [MIT License](https://github.com/modelcontextprotocol/csharp-sdk/blob/main/LICENSE). diff --git a/docs/toc.yml b/docs/toc.yml index eb43788e4..f63a01348 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,4 +1,5 @@ -- name: Home - href: /index +items: - name: API Docs - href: api/ \ No newline at end of file + href: api/ModelContextProtocol.yml +- name: Github + href: https://github.com/ModelContextProtocol/csharp-sdk \ No newline at end of file From 912d14146fa8a3b05585de33faef3263748ceb97 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Tue, 25 Mar 2025 12:34:11 +0000 Subject: [PATCH 7/8] Use a link that passes markdown link validation --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 92c2ac409..facf2093b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ _layout: landing # Overview -The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. Please visit our [API documentation](api/ModelContextProtocol.yml) for more details on available functionality. +The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. Please visit our [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html) for more details on available functionality. ## About MCP From b2ac2420958b994d88f67b2a7f5b5f8a00d6d6a4 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Tue, 25 Mar 2025 12:40:30 +0000 Subject: [PATCH 8/8] remove working directory --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 65a3c4c35..1f54981ad 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,7 +31,6 @@ jobs: dotnet-version: 9.x - name: Generate documentation - working-directory: ./docs run: make generate-docs - name: Upload Pages artifact