Skip to content

Commit 801c73f

Browse files
committed
doc: readme
1 parent 3d3d399 commit 801c73f

File tree

2 files changed

+44
-6
lines changed

2 files changed

+44
-6
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Modern C Support](#modernc)
88
- [Building](#building)
99
- [Development](#development)
10+
- [FAQ](#org73da0a6)
1011
- [License](#license)
1112

1213

@@ -15,9 +16,10 @@
1516

1617
# Overview
1718

18-
mcpc is a Model Context Protocol library in modern C. It aims to:
19+
mcpc is a <b>M</b>odel <b>C</b>ontext <b>P</b>rotocol library in modern <b>C</b>. Its major goals are:
1920

20-
- Provide a bridge between **low-level** infrastructure and AI models
21+
- Provide the **most native** bridge between low-level infrastructure
22+
and AI models
2123
- Explore the maximum capability of the **most recent** C programming language
2224

2325

@@ -424,6 +426,27 @@ our code more readable, inclusive and scalable:
424426
uppercase, otherwise in lowercase.
425427

426428

429+
<a id="org73da0a6"></a>
430+
431+
# FAQ
432+
433+
434+
## Should I prefer mcpc over other SDKs?
435+
436+
It depends on your use case. Roughly speaking, if
437+
438+
1. you prefer your MCP servers or clients to perform tasks in the most
439+
native way (e.g. manually manage memory allocation, equipped with
440+
competitive performance, etc.).
441+
2. you wish your MCP servers or clients are distributed with minimum
442+
software requirements (i.e. you don't want to force users to
443+
have Python, Node.js or similar things installed on their machines)
444+
445+
then mcpc is for you. Otherwise I would strongly recommend you consider
446+
Python, Javscript or other SDKs, they have more intuitive and
447+
easy-to-use high-level APIs for MCP protocol.
448+
449+
427450
<a id="license"></a>
428451

429452
# License

README.org

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
#+title: mcpc
22
#+options: toc:1 num:nil
33

4-
54
* Overview
65
:PROPERTIES:
76
:CUSTOM_ID: overview
87
:END:
98

10-
mcpc is a Model Context Protocol library in modern C. It aims to:
11-
- Provide a bridge between *low-level* infrastructure and AI models
12-
- Explore the maximum capability of the *most recent* C programming language
9+
mcpc is a <b>M</b>odel <b>C</b>ontext <b>P</b>rotocol library in modern <b>C</b>. Its major goals are:
10+
+ Provide the *most native* bridge between low-level infrastructure
11+
and AI models
12+
+ Explore the maximum capability of the *most recent* C programming language
1313

1414
* MCP Features
1515
:PROPERTIES:
@@ -174,6 +174,21 @@ our code more readable, inclusive and scalable:
174174
uppercase, otherwise in lowercase.
175175

176176

177+
* FAQ
178+
179+
** Should I prefer mcpc over other SDKs?
180+
181+
It depends on your use case. Roughly speaking, if
182+
1. you prefer your MCP servers or clients to perform tasks in the most
183+
native way (e.g. manually manage memory allocation, equipped with
184+
competitive performance, etc.).
185+
2. you wish your MCP servers or clients are distributed with minimum
186+
software requirements (i.e. you don't want to force users to
187+
have Python, Node.js or similar things installed on their machines)
188+
then mcpc is for you. Otherwise I would strongly recommend you consider
189+
Python, Javscript or other SDKs, they have more intuitive and
190+
easy-to-use high-level APIs for MCP protocol.
191+
177192
* License
178193
:PROPERTIES:
179194
:CUSTOM_ID: license

0 commit comments

Comments
 (0)