Skip to content

Commit cbad1d2

Browse files
authored
(chore): Documentation updates (modelcontextprotocol#2097)
* Updates. * Fix typos and improve clarity in documentation Corrected various typographical errors, improved grammar, and clarified language across multiple documentation files. These changes enhance readability and ensure consistency in the project's documentation. * Fix typos and improve clarity in Java SDK docs Corrected several typos and improved phrasing in the MCP Java SDK documentation files for client, server, and overview. Changes include fixing grammar, clarifying descriptions, and ensuring consistency in terminology.
1 parent bda81d8 commit cbad1d2

13 files changed

Lines changed: 40 additions & 40 deletions

docs/clients.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ This page provides an overview of applications that support the Model Context Pr
252252

253253
<Note>
254254

255-
This list is maintained by the community. If you notice any inaccuracies or would like to update information about MCP support in your application, please submit a pull request or [open an issue in our documentation repository](https://github.com/modelcontextprotocol/modelcontextprotocol/issues).
255+
This list is maintained by the community. If you notice any inaccuracies or would like to add or update information about MCP support in your application, please [submit a pull request](https://github.com/modelcontextprotocol/modelcontextprotocol/pulls).
256256

257257
</Note>
258258

@@ -1362,7 +1362,7 @@ MCPHub is a powerful Neovim plugin that integrates MCP (Model Context Protocol)
13621362
- Install, configure and manage MCP servers with an intuitive UI.
13631363
- Built-in Neovim MCP server with support for file operations (read, write, search, replace), command execution, terminal integration, LSP integration, buffers, and diagnostics.
13641364
- Create Lua-based MCP servers directly in Neovim.
1365-
- Inegrates with popular Neovim chat plugins Avante.nvim and CodeCompanion.nvim
1365+
- Integrates with popular Neovim chat plugins Avante.nvim and CodeCompanion.nvim
13661366

13671367
</McpClient>
13681368

docs/community/communication.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ The Discord server will have both public and private channels.
3838
- MCP user support: participants are expected to read official documentation and start new GitHub Discussions for questions or support.
3939
- Service or product marketing: interactions on this Discord are expected to be vendor-neutral and not used for brand-building or sales. Mentions of brands or products are discouraged outside of being used as examples or responses to conversations that start off focused on the specification.
4040

41-
#### Private channels (Exceptions)
41+
#### Private Channels (Exceptions)
4242

4343
- **Purpose**: Confidential coordination and sensitive matters that cannot be discussed publicly. Access will be restricted to designated maintainers.
4444
- **Strict criteria for private use**:
4545
- **Security incidents** (CVEs, protocol vulnerabilities).
4646
- **People matters** (maintainer-related discussions, code of conduct policies).
47-
- Select channels will be configured to be **read-only**. This can be good for example for maintainer decision making.
47+
- Select channels will be configured to be **read-only**. This can be useful for maintainer decision-making, for example.
4848
- Coordination requiring **immediate** or otherwise **focused response** with a limited audience.
4949
- **Transparency**:
5050
- **All technical and governance decisions** affecting the community **must be documented** in GitHub Discussions and/or Issues, and will be labeled with `notes`.

docs/community/governance.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Model Context Protocol (MCP) follows a formal governance model to ensure tra
77

88
## General Project Policies
99

10-
Model Context Protocol has been established as Model Context Protocol a Series of LF Projects, LLC. Policies applicable to Model Context Protocol and participants in Model Context Protocol, including guidelines on the usage of trademarks, are located at [https://www.lfprojects.org/policies/](https://www.lfprojects.org/policies/). Governance changes approved as per the provisions of this governance document must also be approved by LF Projects, LLC.
10+
Model Context Protocol has been established as **Model Context Protocol a Series of LF Projects, LLC**. Policies applicable to Model Context Protocol and participants in Model Context Protocol, including guidelines on the usage of trademarks, are located at [https://www.lfprojects.org/policies/](https://www.lfprojects.org/policies/). Governance changes approved as per the provisions of this governance document must also be approved by LF Projects, LLC.
1111

1212
Model Context Protocol participants acknowledge that the copyright in all new contributions will be retained by the copyright holder as independent works of authorship and that no contributor or copyright holder will be required to assign copyrights to the project.
1313

@@ -42,7 +42,7 @@ Maintainers are responsible for the:
4242
- Thoughtful and productive engagement with community contributors,
4343
- Maintaining and improving their respective area of the MCP project,
4444
- Supporting documentation, roadmaps and other adjacent parts of the MCP project,
45-
- Present ideas from community to core.
45+
- Presenting ideas from community to core.
4646

4747
Maintainers are encouraged to propose additional maintainers when needed. Maintainers can only be appointed and removed by core maintainers or lead core maintainers at any time and without reason.
4848

@@ -55,7 +55,7 @@ The core maintainers are expected to have a deep understanding of the Model Cont
5555
- Designing, reviewing and steering the evolution of the MCP specification, as well as all other parts of the MCP project, such as documentation,
5656
- Articulating a cohesive long-term vision for the project,
5757
- Mediating and resolving contentious issues with fairness and transparency, seeking consensus where possible while making decisive choices when necessary,
58-
- Appoint or remove maintainers,
58+
- Appointing or removing maintainers,
5959
- Stewardship of the MCP project in the best interest of MCP.
6060

6161
The core maintainers as a group have the power to veto any decisions made by maintainers by majority vote. The core maintainers have power to resolve disputes as they see fit. The core maintainers should publicly articulate their decision-making. The core group is responsible for adopting their own procedures for making decisions.
@@ -157,7 +157,7 @@ If a Maintainer (or Core / Lead Maintainer) wishes to propose a nomination for t
157157
3. DM a Community Moderator or Core Maintainer to create a private channel in Discord, in the format `nomination-{name}-{group}`. Add all core maintainers, lead maintainers, and co-maintainers on the relevant group.
158158
4. Provide context for the individual under nomination. See below for suggestions on what to include here.
159159
5. Create a Discord Poll and ask Core / Lead Maintainers to vote Yes / No on the nomination. Reaching consensus is encouraged though not required.
160-
6. After Core / Lead Maintainers discuss and/or vote, if the nomination is favorable, relevant members with permissions to update GitHub an Discord roles will add the nominee to the appropriate groups. The nominator should announce the new maintainership in the relevant Discord channel.
160+
6. After Core / Lead Maintainers discuss and/or vote, if the nomination is favorable, relevant members with permissions to update GitHub and Discord roles will add the nominee to the appropriate groups. The nominator should announce the new maintainership in the relevant Discord channel.
161161
7. The temporary Discord channel will be deleted a week later.
162162

163163
Suggestions for the kind of information to share with core maintainers when nominating someone:

docs/community/sep-guidelines.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ Consider proposing a SEP if your change involves any of the following:
2323
- Introducing a new standard for interoperability between different MCP-compatible tools.
2424
- Significant changes to how the specification itself is defined, presented, or validated.
2525
- **A Breaking Change**: Any change that is not backwards-compatible.
26-
- **A Change to Governance or Process**: Any proposal that alters the project's decision-making, contribution guidelines (like this document itself).
26+
- **A Change to Governance or Process**: Any proposal that alters the project's decision-making or contribution guidelines (like this document itself).
2727
- **A Complex or Controversial Topic**: If a change is likely to have multiple valid solutions or generate significant debate, the SEP process provides the necessary framework to explore alternatives, document the rationale, and build community consensus before implementation begins.
2828

2929
## SEP Types
3030

3131
There are three kinds of SEP:
3232

33-
1. **Standards Track** SEP describes a new feature or implementation for the Model Context Protocol. It may also describe an interoperability standard that will be supported outside the core protocol specification.
34-
2. **Informational** SEP describes a Model Context Protocol design issue, or provides general guidelines or information to the MCP community, but does not propose a new feature. Informational SEPs do not necessarily represent an MCP community consensus or recommendation.
35-
3. **Process** SEP describes a process surrounding MCP, or proposes a change to (or an event in) a process. Process SEPs are like Standards Track SEPs but apply to areas other than the MCP protocol itself.
33+
1. A **Standards Track** SEP describes a new feature or implementation for the Model Context Protocol. It may also describe an interoperability standard that will be supported outside the core protocol specification.
34+
2. An **Informational** SEP describes a Model Context Protocol design issue, or provides general guidelines or information to the MCP community, but does not propose a new feature. Informational SEPs do not necessarily represent an MCP community consensus or recommendation.
35+
3. A **Process** SEP describes a process surrounding MCP, or proposes a change to (or an event in) a process. Process SEPs are like Standards Track SEPs but apply to areas other than the MCP protocol itself.
3636

3737
## Submitting a SEP
3838

docs/docs/develop/build-client.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1144,7 +1144,7 @@ export ANTHROPIC_API_KEY='your-anthropic-api-key-here'
11441144

11451145
<Warning>
11461146

1147-
Make sure your keep your `ANTHROPIC_API_KEY` secure!
1147+
Make sure you keep your `ANTHROPIC_API_KEY` secure!
11481148

11491149
</Warning>
11501150

@@ -1652,7 +1652,7 @@ The client will:
16521652
- Get responses from Claude
16531653
4. Exit the session when done
16541654

1655-
Here's an example of what it should look like it connected to a weather server quickstart:
1655+
Here's an example of what it should look like if connected to the weather server quickstart:
16561656

16571657
<Frame>
16581658
<img src="/images/quickstart-dotnet-client.png" />

docs/docs/develop/build-server.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ Writing to stdout will corrupt the JSON-RPC messages and break your server.
383383
### Best Practices
384384

385385
1. Use a logging library that writes to stderr or files, such as `logging` in Python.
386-
2. For JavaScript, be especially careful - `console.log()` writes to stdout by default
386+
2. For JavaScript, be especially careful - `console.log()` writes to stdout by default.
387387

388388
### Quick Examples
389389

@@ -965,8 +965,8 @@ public class WeatherService {
965965
}
966966
```
967967

968-
The `@Service` annotation with auto-register the service in your application context.
969-
The Spring AI `@Tool` annotation, making it easy to create and maintain MCP tools.
968+
The `@Service` annotation will auto-register the service in your application context.
969+
The Spring AI `@Tool` annotation makes it easy to create and maintain MCP tools.
970970

971971
The auto-configuration will automatically register these tools with the MCP server.
972972

@@ -1129,7 +1129,7 @@ You can reuse the existing Anthropic Desktop configuration:
11291129
spring.ai.mcp.client.stdio.servers-configuration=file:PATH/TO/claude_desktop_config.json
11301130
```
11311131

1132-
When you start your client application, the auto-configuration will create, automatically MCP clients from the claude_desktop_config.json.
1132+
When you start your client application, the auto-configuration will automatically create MCP clients from the claude_desktop_config.json.
11331133

11341134
For more information, see the [MCP Client Boot Starters](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-client-docs.html) reference documentation.
11351135

@@ -2246,7 +2246,7 @@ Let's make sure Claude for Desktop is picking up the two tools we've exposed in
22462246
<img src="/images/visual-indicator-mcp-tools.png" />
22472247
</Frame>
22482248

2249-
After clicking on the plus icon, hover over the "Connectors" menu, you should see the `weather`servers listed:
2249+
After clicking on the plus icon, hover over the "Connectors" menu. You should see the `weather` servers listed:
22502250

22512251
<Frame>
22522252
<img src="/images/available-mcp-tools.png" />

docs/docs/develop/connect-remote-servers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Many clients now support remote MCP servers, enabling a wide range of integratio
1111

1212
Remote MCP servers function similarly to local MCP servers but are hosted on the internet rather than your local machine. They expose tools, prompts, and resources that Claude can use to perform tasks on your behalf. These servers can integrate with various services such as project management tools, documentation systems, code repositories, and any other API-enabled service.
1313

14-
The key advantage of remote MCP servers is their accessibility. Unlike local servers that require installation and configuration on each device, remote servers are available from any MCP client with an internet connection. This makes them ideal for web-based AI applications, integrations that emphasize ease-of-use and services that require server-side processing or authentication.
14+
The key advantage of remote MCP servers is their accessibility. Unlike local servers that require installation and configuration on each device, remote servers are available from any MCP client with an internet connection. This makes them ideal for web-based AI applications, integrations that emphasize ease of use, and services that require server-side processing or authentication.
1515

1616
## What are Custom Connectors?
1717

docs/docs/learn/architecture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ For more details about server primitives see [server concepts](./server-concepts
129129

130130
MCP also defines primitives that _clients_ can expose. These primitives allow MCP server authors to build richer interactions.
131131

132-
- **Sampling**: Allows servers to request language model completions from the client's AI application. This is useful when servers' authors want access to a language model, but want to stay model independent and not include a language model SDK in their MCP server. They can use the `sampling/complete` method to request a language model completion from the client's AI application.
133-
- **Elicitation**: Allows servers to request additional information from users. This is useful when servers' authors want to get more information from the user, or ask for confirmation of an action. They can use the `elicitation/request` method to request additional information from the user.
132+
- **Sampling**: Allows servers to request language model completions from the client's AI application. This is useful when server authors want access to a language model, but want to stay model-independent and not include a language model SDK in their MCP server. They can use the `sampling/complete` method to request a language model completion from the client's AI application.
133+
- **Elicitation**: Allows servers to request additional information from users. This is useful when server authors want to get more information from the user, or ask for confirmation of an action. They can use the `elicitation/request` method to request additional information from the user.
134134
- **Logging**: Enables servers to send log messages to clients for debugging and monitoring purposes.
135135

136136
For more details about client primitives see [client concepts](./client-concepts).

docs/docs/learn/server-concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,4 +277,4 @@ Consider a personalized AI travel planner application, with three connected serv
277277
- `createCalendarEvent()` - Adds the trip to the user's calendar
278278
- `sendEmail()` - Sends confirmation with trip details
279279

280-
**The result:** Through multiple MCP servers, the user researched and booked a Barcelona trip tailored to their schedule. The "Plan a Vacation" prompt guided the AI to combine Resources (calendar availability and travel history) with Tools (searching flights, booking hotels, updating calendars) across different servers—gathering context and executing the booking. A task that could've taken hours was completed in minutes using MCP.
280+
**The result:** Through multiple MCP servers, the user researched and booked a Barcelona trip tailored to their schedule. The "Plan a Vacation" prompt guided the AI to combine Resources (calendar availability and travel history) with Tools (searching flights, booking hotels, updating calendars) across different servers—gathering context and executing the booking. A task that could have taken hours was completed in minutes using MCP.

docs/docs/tutorials/security/authorization.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ For more details about implementing MCP servers in TypeScript, refer to the [Typ
618618

619619
You can see the complete Python project in the [sample repository](https://github.com/localden/min-py-mcp-auth).
620620

621-
To simplify our authorization interaction, in Python scenarios we rely on [FastMCP](https://gofastmcp.com/getting-started/welcome). A lot of the conventions around authorization, like the endpoints and token validation logic, are consistent across languages, but some offer simpler ways in integrating them in production scenarios.
621+
To simplify our authorization interaction, in Python scenarios we rely on [FastMCP](https://gofastmcp.com/getting-started/welcome). Many of the conventions around authorization, like the endpoints and token validation logic, are consistent across languages, but some offer simpler ways of integrating them in production scenarios.
622622

623623
Prior to writing the actual server, we need to set up our configuration in `config.py` - the contents are entirely based on your local server setup:
624624

0 commit comments

Comments
 (0)