mirror of
https://github.com/aljazceru/mcp-python-sdk.git
synced 2025-12-19 06:54:18 +01:00
Fix READMEs of examples
This commit is contained in:
@@ -8,10 +8,10 @@ Start the server using either stdio (default) or SSE transport:
|
||||
|
||||
```bash
|
||||
# Using stdio transport (default)
|
||||
mcp-simple-prompt
|
||||
uv mcp-simple-prompt
|
||||
|
||||
# Using SSE transport on custom port
|
||||
mcp-simple-prompt --transport sse --port 8000
|
||||
uv run mcp-simple-prompt --transport sse --port 8000
|
||||
```
|
||||
|
||||
The server exposes a prompt named "simple" that accepts two optional arguments:
|
||||
@@ -21,12 +21,19 @@ The server exposes a prompt named "simple" that accepts two optional arguments:
|
||||
|
||||
## Example
|
||||
|
||||
Using the MCP client, you can retrieve the prompt like this:
|
||||
Using the MCP client, you can retrieve the prompt like this using the STDIO transport:
|
||||
|
||||
```python
|
||||
from mcp.client import ClientSession
|
||||
import asyncio
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.stdio import StdioServerParameters, stdio_client
|
||||
|
||||
async with ClientSession() as session:
|
||||
|
||||
async def main():
|
||||
async with stdio_client(
|
||||
StdioServerParameters(command="uv", args=["run", "mcp-simple-prompt"])
|
||||
) as (read, write):
|
||||
async with ClientSession(read, write) as session:
|
||||
await session.initialize()
|
||||
|
||||
# List available prompts
|
||||
@@ -34,9 +41,15 @@ async with ClientSession() as session:
|
||||
print(prompts)
|
||||
|
||||
# Get the prompt with arguments
|
||||
prompt = await session.get_prompt("simple", {
|
||||
prompt = await session.get_prompt(
|
||||
"simple",
|
||||
{
|
||||
"context": "User is a software developer",
|
||||
"topic": "Python async programming"
|
||||
})
|
||||
"topic": "Python async programming",
|
||||
},
|
||||
)
|
||||
print(prompt)
|
||||
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import sys
|
||||
|
||||
from server import main
|
||||
from .server import main
|
||||
|
||||
sys.exit(main())
|
||||
|
||||
@@ -37,11 +37,7 @@ def create_messages(
|
||||
return messages
|
||||
|
||||
|
||||
@click.group()
|
||||
def cli():
|
||||
pass
|
||||
|
||||
|
||||
@click.command()
|
||||
@click.option("--port", default=8000, help="Port to listen on for SSE")
|
||||
@click.option(
|
||||
"--transport",
|
||||
|
||||
@@ -8,29 +8,41 @@ Start the server using either stdio (default) or SSE transport:
|
||||
|
||||
```bash
|
||||
# Using stdio transport (default)
|
||||
mcp-simple-resource
|
||||
uv run mcp-simple-resource
|
||||
|
||||
# Using SSE transport on custom port
|
||||
mcp-simple-resource --transport sse --port 8000
|
||||
uv run mcp-simple-resource --transport sse --port 8000
|
||||
```
|
||||
|
||||
The server exposes some basic text file resources that can be read by clients.
|
||||
|
||||
## Example
|
||||
|
||||
Using the MCP client, you can read the resources like this:
|
||||
Using the MCP client, you can retrieve resources like this using the STDIO transport:
|
||||
|
||||
```python
|
||||
from mcp.client import ClientSession
|
||||
import asyncio
|
||||
from mcp.types import AnyUrl
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.stdio import StdioServerParameters, stdio_client
|
||||
|
||||
async with ClientSession() as session:
|
||||
|
||||
async def main():
|
||||
async with stdio_client(
|
||||
StdioServerParameters(command="uv", args=["run", "mcp-simple-resource"])
|
||||
) as (read, write):
|
||||
async with ClientSession(read, write) as session:
|
||||
await session.initialize()
|
||||
|
||||
# List available resources
|
||||
resources = await session.list_resources()
|
||||
print(resources)
|
||||
|
||||
# Read a specific resource
|
||||
resource = await session.read_resource(resources[0].uri)
|
||||
# Get a specific resource
|
||||
resource = await session.read_resource(AnyUrl("file:///greeting.txt"))
|
||||
print(resource)
|
||||
|
||||
|
||||
asyncio.run(main())
|
||||
|
||||
```
|
||||
|
||||
@@ -10,12 +10,7 @@ SAMPLE_RESOURCES = {
|
||||
}
|
||||
|
||||
|
||||
@click.group()
|
||||
def cli():
|
||||
pass
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.command()
|
||||
@click.option("--port", default=8000, help="Port to listen on for SSE")
|
||||
@click.option(
|
||||
"--transport",
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# MCP Simple Tool
|
||||
|
||||
A simple MCP server that exposes a website fetching tool.
|
||||
|
||||
@@ -8,10 +7,10 @@ Start the server using either stdio (default) or SSE transport:
|
||||
|
||||
```bash
|
||||
# Using stdio transport (default)
|
||||
mcp-simple-tool
|
||||
uv run mcp-simple-tool
|
||||
|
||||
# Using SSE transport on custom port
|
||||
mcp-simple-tool --transport sse --port 8000
|
||||
uv run mcp-simple-tool --transport sse --port 8000
|
||||
```
|
||||
|
||||
The server exposes a tool named "fetch" that accepts one required argument:
|
||||
@@ -20,12 +19,19 @@ The server exposes a tool named "fetch" that accepts one required argument:
|
||||
|
||||
## Example
|
||||
|
||||
Using the MCP client, you can use the tool like this:
|
||||
Using the MCP client, you can use the tool like this using the STDIO transport:
|
||||
|
||||
```python
|
||||
from mcp.client import ClientSession
|
||||
import asyncio
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.stdio import StdioServerParameters, stdio_client
|
||||
|
||||
async with ClientSession() as session:
|
||||
|
||||
async def main():
|
||||
async with stdio_client(
|
||||
StdioServerParameters(command="uv", args=["run", "mcp-simple-tool"])
|
||||
) as (read, write):
|
||||
async with ClientSession(read, write) as session:
|
||||
await session.initialize()
|
||||
|
||||
# List available tools
|
||||
@@ -33,8 +39,10 @@ async with ClientSession() as session:
|
||||
print(tools)
|
||||
|
||||
# Call the fetch tool
|
||||
result = await session.call_tool("fetch", {
|
||||
"url": "https://example.com"
|
||||
})
|
||||
result = await session.call_tool("fetch", {"url": "https://example.com"})
|
||||
print(result)
|
||||
|
||||
|
||||
asyncio.run(main())
|
||||
|
||||
```
|
||||
|
||||
@@ -17,12 +17,7 @@ async def fetch_website(
|
||||
return [types.TextContent(type="text", text=response.text)]
|
||||
|
||||
|
||||
@click.group()
|
||||
def cli():
|
||||
pass
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.command()
|
||||
@click.option("--port", default=8000, help="Port to listen on for SSE")
|
||||
@click.option(
|
||||
"--transport",
|
||||
|
||||
Reference in New Issue
Block a user