docs: fix multiple typos (#215)
* docs: fix typos on server.mdx * docs: fix typos on client.mdx * docs: fix typos on user.mdx * docs: fix typos on updates.mdx * docs: fix typos on mcp-server.mdx
This commit is contained in:
parent
c035131447
commit
4d80a86f49
5 changed files with 18 additions and 18 deletions
|
|
@ -19,7 +19,7 @@ description: 'The latest updates and improvements to MCP'
|
||||||
- We are exited to announce the availability of the MCP
|
- We are exited to announce the availability of the MCP
|
||||||
[C# SDK](https://github.com/modelcontextprotocol/csharp-sdk/) developed by
|
[C# SDK](https://github.com/modelcontextprotocol/csharp-sdk/) developed by
|
||||||
[Peder Holdgaard Pedersen](http://github.com/PederHP) and Microsoft. This joins our growing
|
[Peder Holdgaard Pedersen](http://github.com/PederHP) and Microsoft. This joins our growing
|
||||||
list of supported languages. The C# SDK is also avaialble as
|
list of supported languages. The C# SDK is also available as
|
||||||
[NuGet package](https://www.nuget.org/packages/ModelContextProtocol)
|
[NuGet package](https://www.nuget.org/packages/ModelContextProtocol)
|
||||||
- Python SDK 1.5.0 was released with multiple fixes and improvements.
|
- Python SDK 1.5.0 was released with multiple fixes and improvements.
|
||||||
</Update>
|
</Update>
|
||||||
|
|
|
||||||
|
|
@ -1088,7 +1088,7 @@ class MCPClient : AutoCloseable {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server connection managment
|
### Server connection management
|
||||||
|
|
||||||
Next, we'll implement the method to connect to an MCP server:
|
Next, we'll implement the method to connect to an MCP server:
|
||||||
|
|
||||||
|
|
@ -1339,7 +1339,7 @@ Example of correct path usage:
|
||||||
# Relative path
|
# Relative path
|
||||||
java -jar build/libs/client.jar ./server/build/libs/server.jar
|
java -jar build/libs/client.jar ./server/build/libs/server.jar
|
||||||
|
|
||||||
# Absoulute path
|
# Absolute path
|
||||||
java -jar build/libs/client.jar /Users/username/projects/mcp-server/build/libs/server.jar
|
java -jar build/libs/client.jar /Users/username/projects/mcp-server/build/libs/server.jar
|
||||||
|
|
||||||
# Windows path (either format works)
|
# Windows path (either format works)
|
||||||
|
|
|
||||||
|
|
@ -765,7 +765,7 @@ For manual MCP Server implementation, refer to the [MCP Server Java SDK document
|
||||||
|
|
||||||
### Set up your environment
|
### Set up your environment
|
||||||
|
|
||||||
Use the [Spring Initizer](https://start.spring.io/) to bootstrat the project.
|
Use the [Spring Initializer](https://start.spring.io/) to bootstrap the project.
|
||||||
|
|
||||||
You will need to add the following dependencies:
|
You will need to add the following dependencies:
|
||||||
|
|
||||||
|
|
@ -795,7 +795,7 @@ You will need to add the following dependencies:
|
||||||
</Tab>
|
</Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
Then configure your application by setting the applicaiton properties:
|
Then configure your application by setting the application properties:
|
||||||
|
|
||||||
<CodeGroup>
|
<CodeGroup>
|
||||||
|
|
||||||
|
|
@ -822,7 +822,7 @@ Now let's dive into building your server.
|
||||||
|
|
||||||
### Weather Service
|
### Weather Service
|
||||||
|
|
||||||
Let's implement a [WeatheService.java](https://github.com/spring-projects/spring-ai-examples/blob/main/model-context-protocol/weather/starter-stdio-server/src/main/java/org/springframework/ai/mcp/sample/server/WeatherService.java) that uses a REST client to query the data from the National Weather Service API:
|
Let's implement a [WeatherService.java](https://github.com/spring-projects/spring-ai-examples/blob/main/model-context-protocol/weather/starter-stdio-server/src/main/java/org/springframework/ai/mcp/sample/server/WeatherService.java) that uses a REST client to query the data from the National Weather Service API:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@Service
|
@Service
|
||||||
|
|
@ -865,12 +865,12 @@ public class WeatherService {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `@Service` annotation with auto-register the service in your applicaiton context.
|
The `@Service` annotation with auto-register the service in your application context.
|
||||||
The Spring AI `@Tool` annotation, making it easy to create and maintain MCP tools.
|
The Spring AI `@Tool` annotation, making it easy to create and maintain MCP tools.
|
||||||
|
|
||||||
The auto-configuration will automatically register these tools with the MCP server.
|
The auto-configuration will automatically register these tools with the MCP server.
|
||||||
|
|
||||||
### Create your Boot Applicaiton
|
### Create your Boot Application
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@SpringBootApplication
|
@SpringBootApplication
|
||||||
|
|
@ -887,7 +887,7 @@ public class McpServerApplication {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Uses the the `MethodToolCallbackProvider` utils to convert the `@Tools` into actionalble callbackes used by the MCP server.
|
Uses the the `MethodToolCallbackProvider` utils to convert the `@Tools` into actionable callbacks used by the MCP server.
|
||||||
|
|
||||||
### Running the server
|
### Running the server
|
||||||
|
|
||||||
|
|
@ -1011,7 +1011,7 @@ mcpClient.closeGracefully();
|
||||||
|
|
||||||
### Use MCP Client Boot Starter
|
### Use MCP Client Boot Starter
|
||||||
|
|
||||||
Create a new boot starter applicaiton using the `spring-ai-starter-mcp-client` dependency:
|
Create a new boot starter application using the `spring-ai-starter-mcp-client` dependency:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<dependency>
|
<dependency>
|
||||||
|
|
@ -1021,13 +1021,13 @@ Create a new boot starter applicaiton using the `spring-ai-starter-mcp-client` d
|
||||||
```
|
```
|
||||||
|
|
||||||
and set the `spring.ai.mcp.client.stdio.servers-configuration` property to point to your `claude_desktop_config.json`.
|
and set the `spring.ai.mcp.client.stdio.servers-configuration` property to point to your `claude_desktop_config.json`.
|
||||||
You can re-use the existing Anthropic Destop configuration:
|
You can re-use the existing Anthropic Desktop configuration:
|
||||||
|
|
||||||
```properties
|
```properties
|
||||||
spring.ai.mcp.client.stdio.servers-configuration=file:PATH/TO/claude_desktop_config.json
|
spring.ai.mcp.client.stdio.servers-configuration=file:PATH/TO/claude_desktop_config.json
|
||||||
```
|
```
|
||||||
|
|
||||||
When you start your client applicaiton, the auto-configuration will create, automatically MCP clients from the claude_desktop_config.json.
|
When you start your client application, the auto-configuration will create, automatically MCP clients from the claude_desktop_config.json.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@ This is what it should look like on a Mac:
|
||||||
<img src="/images/quickstart-menu.png" width="400" />
|
<img src="/images/quickstart-menu.png" width="400" />
|
||||||
</Frame>
|
</Frame>
|
||||||
|
|
||||||
Click on "Developer" in the lefthand bar of the Settings pane, and then click on "Edit Config":
|
Click on "Developer" in the left-hand bar of the Settings pane, and then click on "Edit Config":
|
||||||
<Frame>
|
<Frame>
|
||||||
<img src="/images/quickstart-developer.png" />
|
<img src="/images/quickstart-developer.png" />
|
||||||
</Frame>
|
</Frame>
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ The MCP Server is a foundational component in the Model Context Protocol (MCP) a
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
The [Spring-AI MCP Server](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-starter-docs.html) integration extends the MCP Java SDK to
|
The [Spring-AI MCP Server](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-starter-docs.html) integration extends the MCP Java SDK to
|
||||||
provide auto-configuration for MCP servdr functionality in Spring Boot applications.
|
provide auto-configuration for MCP server functionality in Spring Boot applications.
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
The server supports both synchronous and asynchronous APIs, allowing for flexible integration in different application contexts.
|
The server supports both synchronous and asynchronous APIs, allowing for flexible integration in different application contexts.
|
||||||
|
|
@ -246,7 +246,7 @@ var capabilities = ServerCapabilities.builder()
|
||||||
.resources(false, true) // Resource support with list changes notifications
|
.resources(false, true) // Resource support with list changes notifications
|
||||||
.tools(true) // Tool support with list changes notifications
|
.tools(true) // Tool support with list changes notifications
|
||||||
.prompts(true) // Prompt support with list changes notifications
|
.prompts(true) // Prompt support with list changes notifications
|
||||||
.logging() // Enable logging support (enabled by default with loging level INFO)
|
.logging() // Enable logging support (enabled by default with logging level INFO)
|
||||||
.build();
|
.build();
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -293,7 +293,7 @@ var schema = """
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
""";
|
""";
|
||||||
var syncToolSpecification = new McpServerFeatures.SyncToolSpecificaiton(
|
var syncToolSpecification = new McpServerFeatures.SyncToolSpecification(
|
||||||
new Tool("calculator", "Basic calculator", schema),
|
new Tool("calculator", "Basic calculator", schema),
|
||||||
(exchange, arguments) -> {
|
(exchange, arguments) -> {
|
||||||
// Tool implementation
|
// Tool implementation
|
||||||
|
|
@ -323,7 +323,7 @@ var schema = """
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
""";
|
""";
|
||||||
var asyncToolSpecification = new McpServerFeatures.AsyncToolSpecificaiton(
|
var asyncToolSpecification = new McpServerFeatures.AsyncToolSpecification(
|
||||||
new Tool("calculator", "Basic calculator", schema),
|
new Tool("calculator", "Basic calculator", schema),
|
||||||
(exchange, arguments) -> {
|
(exchange, arguments) -> {
|
||||||
// Tool implementation
|
// Tool implementation
|
||||||
|
|
@ -371,7 +371,7 @@ var asyncResourceSpecification = new McpServerFeatures.asyncResourceSpecificatio
|
||||||
</Tab>
|
</Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
The resource specification compriese of resource definitions and resource read handler.
|
The resource specification comprised of resource definitions and resource read handler.
|
||||||
The resource definition including `name`, `description`, and `MIME type`.
|
The resource definition including `name`, `description`, and `MIME type`.
|
||||||
The first argument of the function that handles resource read requests is an `McpAsyncServerExchange` upon which the server can
|
The first argument of the function that handles resource read requests is an `McpAsyncServerExchange` upon which the server can
|
||||||
interact with the connected client.
|
interact with the connected client.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue