Skip to content

Commit 713aa39

Browse files
committed
docs: improve README.md and project docs
1 parent ace3bd4 commit 713aa39

2 files changed

Lines changed: 39 additions & 20 deletions

File tree

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ mode: STDIO
6969
name: my-first-mcp-server
7070
version: 1.0.0
7171
type: SYNC
72+
instructions: You are a helpful AI assistant
7273
request-timeout: 20000
7374
capabilities:
7475
resource: true
@@ -180,11 +181,14 @@ mode: STREAMABLE
180181
name: my-mcp-server
181182
version: 1.0.0
182183
type: SYNC
184+
instructions: You are a helpful AI assistant
183185
request-timeout: 20000
184186
capabilities:
185187
resource: true
188+
subscribe-resource: true
186189
prompt: true
187190
tool: true
191+
completion: true
188192
change-notification:
189193
resource: true
190194
prompt: true
@@ -198,16 +202,23 @@ streamable:
198202
199203
### Configuration Properties
200204
201-
| Property | Description | Default |
202-
|-----------------------|-------------------------------------------|--------------|
203-
| `enabled` | Enable/disable MCP server | `true` |
204-
| `mode` | Server mode: `STDIO`, `SSE`, `STREAMABLE` | `STREAMABLE` |
205-
| `name` | Server name | `mcp-server` |
206-
| `version` | Server version | `1.0.0` |
207-
| `type` | Server type: `SYNC`, `ASYNC` | `SYNC` |
208-
| `request-timeout` | Request timeout in milliseconds | `20000` |
209-
| `capabilities` | Enable resources, prompts, tools | all `true` |
210-
| `change-notification` | Enable change notifications | all `true` |
205+
| Property | Description | Default |
206+
|-----------------------------------|-------------------------------------------|--------------|
207+
| `enabled` | Enable/disable MCP server | `true` |
208+
| `mode` | Server mode: `STDIO`, `SSE`, `STREAMABLE` | `STREAMABLE` |
209+
| `name` | Server name | `mcp-server` |
210+
| `version` | Server version | `1.0.0` |
211+
| `type` | Server type: `SYNC`, `ASYNC` | `SYNC` |
212+
| `instructions` | Instructions for the LLM client | (empty) |
213+
| `request-timeout` | Request timeout in milliseconds | `20000` |
214+
| `capabilities.resource` | Enable resource support | `true` |
215+
| `capabilities.subscribe-resource` | Enable resource subscription | `true` |
216+
| `capabilities.prompt` | Enable prompt support | `true` |
217+
| `capabilities.tool` | Enable tool support | `true` |
218+
| `capabilities.completion` | Enable completion support | `true` |
219+
| `change-notification.resource` | Notify clients on resource change | `true` |
220+
| `change-notification.prompt` | Notify clients on prompt change | `true` |
221+
| `change-notification.tool` | Notify clients on tool change | `true` |
211222

212223
### Profile-based Configuration
213224

docs/getting-started.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ mode: STDIO
4141
name: my-first-mcp-server
4242
version: 1.0.0
4343
type: SYNC
44+
instructions: You are a helpful AI assistant
4445
request-timeout: 20000
4546
capabilities:
4647
resource: true
@@ -159,16 +160,23 @@ streamable:
159160
160161
## Configuration Properties
161162
162-
| Property | Description | Default |
163-
|-----------------------|-------------------------------------------|--------------|
164-
| `enabled` | Enable/disable MCP server | `true` |
165-
| `mode` | Server mode: `STDIO`, `SSE`, `STREAMABLE` | `STREAMABLE` |
166-
| `name` | Server name | `mcp-server` |
167-
| `version` | Server version | `1.0.0` |
168-
| `type` | Server type: `SYNC`, `ASYNC` | `SYNC` |
169-
| `request-timeout` | Request timeout in milliseconds | `20000` |
170-
| `capabilities` | Enable resources, prompts, tools | all `true` |
171-
| `change-notification` | Enable change notifications | all `true` |
163+
| Property | Description | Default |
164+
|-----------------------------------|-------------------------------------------|--------------|
165+
| `enabled` | Enable/disable MCP server | `true` |
166+
| `mode` | Server mode: `STDIO`, `SSE`, `STREAMABLE` | `STREAMABLE` |
167+
| `name` | Server name | `mcp-server` |
168+
| `version` | Server version | `1.0.0` |
169+
| `type` | Server type: `SYNC`, `ASYNC` | `SYNC` |
170+
| `instructions` | Instructions for the LLM client | (empty) |
171+
| `request-timeout` | Request timeout in milliseconds | `20000` |
172+
| `capabilities.resource` | Enable resource support | `true` |
173+
| `capabilities.subscribe-resource` | Enable resource subscription | `true` |
174+
| `capabilities.prompt` | Enable prompt support | `true` |
175+
| `capabilities.tool` | Enable tool support | `true` |
176+
| `capabilities.completion` | Enable completion support | `true` |
177+
| `change-notification.resource` | Notify clients on resource change | `true` |
178+
| `change-notification.prompt` | Notify clients on prompt change | `true` |
179+
| `change-notification.tool` | Notify clients on tool change | `true` |
172180

173181
## Profile-based Configuration
174182

0 commit comments

Comments
 (0)