scitex 2.13.0__py3-none-any.whl → 2.15.1__py3-none-any.whl

scitex/scholar/docs/to_claude/guidelines/python/official/fastmcp-README.md

@@ -1,442 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-08-24 20:11:31
-!-- Author: ywatanabe
-!-- File: /home/ywatanabe/proj/emacs_monitor_mcp_server/docs/from_user/fast_mcp_readme.md
-!-- --- -->
-
-<div align="center">
-
-<!-- omit in toc -->
-# FastMCP v2 🚀
-
-<strong>The fast, Pythonic way to build MCP servers and clients.</strong>
-
-*Made with ☕️ by [Prefect](https://www.prefect.io/)*
-
-[![Docs](https://img.shields.io/badge/docs-gofastmcp.com-blue)](https://gofastmcp.com)
-[![PyPI - Version](https://img.shields.io/pypi/v/fastmcp.svg)](https://pypi.org/project/fastmcp)
-[![Tests](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml/badge.svg)](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
-[![License](https://img.shields.io/github/license/jlowin/fastmcp.svg)](https://github.com/jlowin/fastmcp/blob/main/LICENSE)
-
-<a href="https://trendshift.io/repositories/13266" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13266" alt="jlowin%2Ffastmcp | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
-</div>
-
-> [!Note]
->
-> #### Beyond the Protocol
->
-> FastMCP is the standard framework for working with the Model Context Protocol. FastMCP 1.0 was incorporated into the [official MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk) in 2024.
->
-> This is FastMCP 2.0, the **actively maintained version** that provides a complete toolkit for working with the MCP ecosystem.
->
-> FastMCP 2.0 has a comprehensive set of features that go far beyond the core MCP specification, all in service of providing **the simplest path to production**. These include deployment, auth, clients, server proxying and composition, generating servers from REST APIs, dynamic tool rewriting, built-in testing tools, integrations, and more.
->
-> Ready to upgrade or get started? Follow the [installation instructions](https://gofastmcp.com/getting-started/installation), which include steps for upgrading from the official MCP SDK.
-
----
-
-The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) is a new, standardized way to provide context and tools to your LLMs, and FastMCP makes building MCP servers and clients simple and intuitive. Create tools, expose resources, define prompts, and connect components with clean, Pythonic code.
-
-```python
-# server.py
-from fastmcp import FastMCP
-
-mcp = FastMCP("Demo 🚀")
-
-@mcp.tool
-def add(a: int, b: int) -> int:
-    """Add two numbers"""
-    return a + b
-
-if __name__ == "__main__":
-    mcp.run()
-```
-
-Run the server locally:
-
-```bash
-fastmcp run server.py
-```
-
-### 📚 Documentation
-
-FastMCP's complete documentation is available at **[gofastmcp.com](https://gofastmcp.com)**, including detailed guides, API references, and advanced patterns. This readme provides only a high-level overview.
-
-Documentation is also available in [llms.txt format](https://llmstxt.org/), which is a simple markdown standard that LLMs can consume easily.
-
-There are two ways to access the LLM-friendly documentation:
-
-- [`llms.txt`](https://gofastmcp.com/llms.txt) is essentially a sitemap, listing all the pages in the documentation.
-- [`llms-full.txt`](https://gofastmcp.com/llms-full.txt) contains the entire documentation. Note this may exceed the context window of your LLM.
-
----
-
-<!-- omit in toc -->
-## Table of Contents
-
-- [What is MCP?](#what-is-mcp)
-- [Why FastMCP?](#why-fastmcp)
-- [Installation](#installation)
-- [Core Concepts](#core-concepts)
-  - [The `FastMCP` Server](#the-fastmcp-server)
-  - [Tools](#tools)
-  - [Resources \& Templates](#resources--templates)
-  - [Prompts](#prompts)
-  - [Context](#context)
-  - [MCP Clients](#mcp-clients)
-- [Advanced Features](#advanced-features)
-  - [Proxy Servers](#proxy-servers)
-  - [Composing MCP Servers](#composing-mcp-servers)
-  - [OpenAPI \& FastAPI Generation](#openapi--fastapi-generation)
-  - [Authentication \& Security](#authentication--security)
-- [Running Your Server](#running-your-server)
-- [Contributing](#contributing)
-  - [Prerequisites](#prerequisites)
-  - [Setup](#setup)
-  - [Unit Tests](#unit-tests)
-  - [Static Checks](#static-checks)
-  - [Pull Requests](#pull-requests)
-
----
-
-## What is MCP?
-
-The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) lets you build servers that expose data and functionality to LLM applications in a secure, standardized way. It is often described as "the USB-C port for AI", providing a uniform way to connect LLMs to resources they can use. It may be easier to think of it as an API, but specifically designed for LLM interactions. MCP servers can:
-
-- Expose data through **Resources** (think of these sort of like GET endpoints; they are used to load information into the LLM's context)
-- Provide functionality through **Tools** (sort of like POST endpoints; they are used to execute code or otherwise produce a side effect)
-- Define interaction patterns through **Prompts** (reusable templates for LLM interactions)
-- And more!
-
-FastMCP provides a high-level, Pythonic interface for building, managing, and interacting with these servers.
-
-## Why FastMCP?
-
-The MCP protocol is powerful but implementing it involves a lot of boilerplate - server setup, protocol handlers, content types, error management. FastMCP handles all the complex protocol details and server management, so you can focus on building great tools. It's designed to be high-level and Pythonic; in most cases, decorating a function is all you need.
-
-FastMCP 2.0 has evolved into a comprehensive platform that goes far beyond basic protocol implementation. While 1.0 provided server-building capabilities (and is now part of the official MCP SDK), 2.0 offers a complete ecosystem including client libraries, authentication systems, deployment tools, integrations with major AI platforms, testing frameworks, and production-ready infrastructure patterns.
-
-FastMCP aims to be:
-
-🚀 **Fast:** High-level interface means less code and faster development
-
-🍀 **Simple:** Build MCP servers with minimal boilerplate
-
-🐍 **Pythonic:** Feels natural to Python developers
-
-🔍 **Complete:** A comprehensive platform for all MCP use cases, from dev to prod
-
-## Installation
-
-We recommend installing FastMCP with [uv](https://docs.astral.sh/uv/):
-
-```bash
-uv pip install fastmcp
-```
-
-For full installation instructions, including verification, upgrading from the official MCPSDK, and developer setup, see the [**Installation Guide**](https://gofastmcp.com/getting-started/installation).
-
-## Core Concepts
-
-These are the building blocks for creating MCP servers and clients with FastMCP.
-
-### The `FastMCP` Server
-
-The central object representing your MCP application. It holds your tools, resources, and prompts, manages connections, and can be configured with settings like authentication.
-
-```python
-from fastmcp import FastMCP
-
-# Create a server instance
-mcp = FastMCP(name="MyAssistantServer")
-```
-
-Learn more in the [**FastMCP Server Documentation**](https://gofastmcp.com/servers/fastmcp).
-
-### Tools
-
-Tools allow LLMs to perform actions by executing your Python functions (sync or async). Ideal for computations, API calls, or side effects (like `POST`/`PUT`). FastMCP handles schema generation from type hints and docstrings. Tools can return various types, including text, JSON-serializable objects, and even images or audio aided by the FastMCP media helper classes.
-
-```python
-@mcp.tool
-def multiply(a: float, b: float) -> float:
-    """Multiplies two numbers."""
-    return a * b
-```
-
-Learn more in the [**Tools Documentation**](https://gofastmcp.com/servers/tools).
-
-### Resources & Templates
-
-Resources expose read-only data sources (like `GET` requests). Use `@mcp.resource("your://uri")`. Use `{placeholders}` in the URI to create dynamic templates that accept parameters, allowing clients to request specific data subsets.
-
-```python
-# Static resource
-@mcp.resource("config://version")
-def get_version(): 
-    return "2.0.1"
-
-# Dynamic resource template
-@mcp.resource("users://{user_id}/profile")
-def get_profile(user_id: int):
-    # Fetch profile for user_id...
-    return {"name": f"User {user_id}", "status": "active"}
-```
-
-Learn more in the [**Resources & Templates Documentation**](https://gofastmcp.com/servers/resources).
-
-### Prompts
-
-Prompts define reusable message templates to guide LLM interactions. Decorate functions with `@mcp.prompt`. Return strings or `Message` objects.
-
-```python
-@mcp.prompt
-def summarize_request(text: str) -> str:
-    """Generate a prompt asking for a summary."""
-    return f"Please summarize the following text:\n\n{text}"
-```
-
-Learn more in the [**Prompts Documentation**](https://gofastmcp.com/servers/prompts).
-
-### Context
-
-Access MCP session capabilities within your tools, resources, or prompts by adding a `ctx: Context` parameter. Context provides methods for:
-
-- **Logging:** Log messages to MCP clients with `ctx.info()`, `ctx.error()`, etc.
-- **LLM Sampling:** Use `ctx.sample()` to request completions from the client's LLM.
-- **HTTP Request:** Use `ctx.http_request()` to make HTTP requests to other servers.
-- **Resource Access:** Use `ctx.read_resource()` to access resources on the server
-- **Progress Reporting:** Use `ctx.report_progress()` to report progress to the client.
-- and more...
-
-To access the context, add a parameter annotated as `Context` to any mcp-decorated function. FastMCP will automatically inject the correct context object when the function is called.
-
-```python
-from fastmcp import FastMCP, Context
-
-mcp = FastMCP("My MCP Server")
-
-@mcp.tool
-async def process_data(uri: str, ctx: Context):
-    # Log a message to the client
-    await ctx.info(f"Processing {uri}...")
-
-    # Read a resource from the server
-    data = await ctx.read_resource(uri)
-
-    # Ask client LLM to summarize the data
-    summary = await ctx.sample(f"Summarize: {data.content[:500]}")
-
-    # Return the summary
-    return summary.text
-```
-
-Learn more in the [**Context Documentation**](https://gofastmcp.com/servers/context).
-
-### MCP Clients
-
-Interact with *any* MCP server programmatically using the `fastmcp.Client`. It supports various transports (Stdio, SSE, In-Memory) and often auto-detects the correct one. The client can also handle advanced patterns like server-initiated **LLM sampling requests** if you provide an appropriate handler.
-
-Critically, the client allows for efficient **in-memory testing** of your servers by connecting directly to a `FastMCP` server instance via the `FastMCPTransport`, eliminating the need for process management or network calls during tests.
-
-```python
-from fastmcp import Client
-
-async def main():
-    # Connect via stdio to a local script
-    async with Client("my_server.py") as client:
-        tools = await client.list_tools()
-        print(f"Available tools: {tools}")
-        result = await client.call_tool("add", {"a": 5, "b": 3})
-        print(f"Result: {result.text}")
-
-    # Connect via SSE
-    async with Client("http://localhost:8000/sse") as client:
-        # ... use the client
-        pass
-```
-
-To use clients to test servers, use the following pattern:
-
-```python
-from fastmcp import FastMCP, Client
-
-mcp = FastMCP("My MCP Server")
-
-async def main():
-    # Connect via in-memory transport
-    async with Client(mcp) as client:
-        # ... use the client
-```
-
-FastMCP also supports connecting to multiple servers through a single unified client using the standard MCP configuration format:
-
-```python
-from fastmcp import Client
-
-# Standard MCP configuration with multiple servers
-config = {
-    "mcpServers": {
-        "weather": {"url": "https://weather-api.example.com/mcp"},
-        "assistant": {"command": "python", "args": ["./assistant_server.py"]}
-    }
-}
-
-# Create a client that connects to all servers
-client = Client(config)
-
-async def main():
-    async with client:
-        # Access tools and resources with server prefixes
-        forecast = await client.call_tool("weather_get_forecast", {"city": "London"})
-        answer = await client.call_tool("assistant_answer_question", {"query": "What is MCP?"})
-```
-
-Learn more in the [**Client Documentation**](https://gofastmcp.com/clients/client) and [**Transports Documentation**](https://gofastmcp.com/clients/transports).
-
-## Advanced Features
-
-FastMCP introduces powerful ways to structure and deploy your MCP applications.
-
-### Proxy Servers
-
-Create a FastMCP server that acts as an intermediary for another local or remote MCP server using `FastMCP.as_proxy()`. This is especially useful for bridging transports (e.g., remote SSE to local Stdio) or adding a layer of logic to a server you don't control.
-
-Learn more in the [**Proxying Documentation**](https://gofastmcp.com/patterns/proxy).
-
-### Composing MCP Servers
-
-Build modular applications by mounting multiple `FastMCP` instances onto a parent server using `mcp.mount()` (live link) or `mcp.import_server()` (static copy).
-
-Learn more in the [**Composition Documentation**](https://gofastmcp.com/patterns/composition).
-
-### OpenAPI & FastAPI Generation
-
-Automatically generate FastMCP servers from existing OpenAPI specifications (`FastMCP.from_openapi()`) or FastAPI applications (`FastMCP.from_fastapi()`), instantly bringing your web APIs to the MCP ecosystem.
-
-Learn more: [**OpenAPI Integration**](https://gofastmcp.com/integrations/openapi) | [**FastAPI Integration**](https://gofastmcp.com/integrations/fastapi).
-
-### Authentication & Security
-
-FastMCP provides built-in authentication support to secure both your MCP servers and clients in production environments. Protect your server endpoints from unauthorized access and authenticate your clients against secured MCP servers using industry-standard protocols.
-
-- **Server Protection**: Secure your FastMCP server endpoints with configurable authentication providers
-- **Client Authentication**: Connect to authenticated MCP servers with automatic credential management
-- **Production Ready**: Support for common authentication patterns used in enterprise environments
-
-Learn more in the **Authentication Documentation** for [servers](https://gofastmcp.com/servers/auth) and [clients](https://gofastmcp.com/clients/auth).
-
-## Running Your Server
-
-The main way to run a FastMCP server is by calling the `run()` method on your server instance:
-
-```python
-# server.py
-from fastmcp import FastMCP
-
-mcp = FastMCP("Demo 🚀")
-
-@mcp.tool
-def hello(name: str) -> str:
-    return f"Hello, {name}!"
-
-if __name__ == "__main__":
-    mcp.run()  # Default: uses STDIO transport
-```
-
-FastMCP supports three transport protocols:
-
-**STDIO (Default)**: Best for local tools and command-line scripts.
-
-```python
-mcp.run(transport="stdio")  # Default, so transport argument is optional
-```
-
-**Streamable HTTP**: Recommended for web deployments.
-
-```python
-mcp.run(transport="http", host="127.0.0.1", port=8000, path="/mcp")
-```
-
-**SSE**: For compatibility with existing SSE clients.
-
-```python
-mcp.run(transport="sse", host="127.0.0.1", port=8000)
-```
-
-See the [**Running Server Documentation**](https://gofastmcp.com/deployment/running-server) for more details.
-
-## Contributing
-
-Contributions are the core of open source! We welcome improvements and features.
-
-### Prerequisites
-
-- Python 3.10+
-- [uv](https://docs.astral.sh/uv/) (Recommended for environment management)
-
-### Setup
-
-1. Clone the repository:
-
-   ```bash
-   git clone https://github.com/jlowin/fastmcp.git 
-   cd fastmcp
-   ```
-
-2. Create and sync the environment:
-
-   ```bash
-   uv sync
-   ```
-
-   This installs all dependencies, including dev tools.
-
-3. Activate the virtual environment (e.g., `source .venv/bin/activate` or via your IDE).
-
-### Unit Tests
-
-FastMCP has a comprehensive unit test suite. All PRs must introduce or update tests as appropriate and pass the full suite.
-
-Run tests using pytest:
-
-```bash
-pytest
-```
-
-or if you want an overview of the code coverage
-
-```bash
-uv run pytest --cov=src --cov=examples --cov-report=html
-```
-
-### Static Checks
-
-FastMCP uses `pre-commit` for code formatting, linting, and type-checking. All PRs must pass these checks (they run automatically in CI).
-
-Install the hooks locally:
-
-```bash
-uv run pre-commit install
-```
-
-The hooks will now run automatically on `git commit`. You can also run them manually at any time:
-
-```bash
-pre-commit run --all-files
-# or via uv
-uv run pre-commit run --all-files
-```
-
-### Pull Requests
-
-1. Fork the repository on GitHub.
-2. Create a feature branch from `main`.
-3. Make your changes, including tests and documentation updates.
-4. Ensure tests and pre-commit hooks pass.
-5. Commit your changes and push to your fork.
-6. Open a pull request against the `main` branch of `jlowin/fastmcp`.
-
-Please open an issue or discussion for questions or suggestions before starting significant work!
-
-<!-- EOF -->

scitex/scholar/docs/to_claude/guidelines/python/official/fastmcp-TESTING.md

@@ -1,146 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-08-27 09:18:35
-!-- Author: ywatanabe
-!-- File: /home/ywatanabe/proj/minimal-pip-project/docs/to_claude/FastMCP_official_testing.md
-!-- --- -->
-
-The FastMCP Client is a deterministic testing tool that gives you complete programmatic control over MCP server interactions. You call specific tools with exact arguments, verify responses, and test edge cases - making it ideal for unit testing your MCP servers.
-​
-In-Memory Testing
-The FastMCP Client’s standout feature is in-memory testing. Instead of deploying your server or managing network connections, you pass your server instance directly to the client. This creates a zero-overhead connection that runs entirely in memory.
-What makes this approach so powerful is that everything runs in the same Python process. You can set breakpoints anywhere - in your test code or inside your server handlers - and step through with your debugger. There’s no server startup scripts, no port management, no cleanup between tests. Tests execute instantly without network overhead.
-
-Copy
-from fastmcp import FastMCP, Client
-
-# Create your server
-server = FastMCP("WeatherServer")
-
-@server.tool
-def get_temperature(city: str) -> dict:
-    """Get current temperature for a city"""
-    temps = {"NYC": 72, "LA": 85, "Chicago": 68}
-    return {"city": city, "temp": temps.get(city, 70)}
-
-@server.resource("weather://forecast")
-def get_forecast() -> dict:
-    """Get 5-day forecast"""
-    return {"days": 5, "conditions": "sunny"}
-
-async def test_weather_operations():
-    # Pass server directly - no deployment needed
-    async with Client(server) as client:
-        # Test tool execution
-        result = await client.call_tool("get_temperature", {"city": "NYC"})
-        assert result.data == {"city": "NYC", "temp": 72}
-        
-        # Test resource retrieval
-        forecast = await client.read_resource("weather://forecast")
-        assert forecast.contents[0].data == {"days": 5, "conditions": "sunny"}
-The in-memory approach transforms MCP testing from a deployment challenge into standard unit testing. You focus on testing your server’s behavior, not wrestling with infrastructure.
-​
-Testing with Frameworks
-The FastMCP Client works seamlessly with any Python testing framework. Whether you prefer pytest, unittest, or another framework, the pattern remains consistent: create a server, pass it to the client, and verify behavior.
-
-Copy
-import pytest
-from fastmcp import FastMCP, Client
-
-@pytest.fixture
-def weather_server():
-    server = FastMCP("WeatherServer")
-    
-    @server.tool
-    def get_temperature(city: str) -> dict:
-        temps = {"NYC": 72, "LA": 85, "Chicago": 68}
-        return {"city": city, "temp": temps.get(city, 70)}
-    
-    return server
-
-@pytest.mark.asyncio
-async def test_temperature_tool(weather_server):
-    async with Client(weather_server) as client:
-        result = await client.call_tool("get_temperature", {"city": "LA"})
-        assert result.data == {"city": "LA", "temp": 85}
-
-@pytest.mark.asyncio
-async def test_unknown_city(weather_server):
-    async with Client(weather_server) as client:
-        result = await client.call_tool("get_temperature", {"city": "Paris"})
-        assert result.data["temp"] == 70  # Default temperature
-​
-Mocking External Dependencies
-FastMCP servers are standard Python objects, so you can mock external dependencies using your preferred mocking approach. Replace databases, APIs, or any external service with test doubles to keep your tests fast and deterministic.
-
-Copy
-from unittest.mock import AsyncMock
-
-async def test_database_tool():
-    server = FastMCP("DataServer")
-    
-    # Mock the database
-    mock_db = AsyncMock()
-    mock_db.fetch_users.return_value = [
-        {"id": 1, "name": "Alice"},
-        {"id": 2, "name": "Bob"}
-    ]
-    
-    @server.tool
-    async def list_users() -> list:
-        return await mock_db.fetch_users()
-    
-    async with Client(server) as client:
-        result = await client.call_tool("list_users", {})
-        assert len(result.data) == 2
-        assert result.data[0]["name"] == "Alice"
-        mock_db.fetch_users.assert_called_once()
-​
-Testing Deployed Servers
-While in-memory testing covers most unit testing needs, you’ll occasionally need to test against a deployed server - to verify authentication, test network behavior, or validate deployments.
-​
-HTTP Transport Testing
-When you need to test actual network behavior or verify a deployment, connect to your running server using its URL:
-
-Copy
-from fastmcp import Client
-
-async def test_deployed_server():
-    # Connect to a running server
-    async with Client("http://localhost:8000/mcp/") as client:
-        await client.ping()
-        
-        # Test with real network transport
-        tools = await client.list_tools()
-        assert len(tools) > 0
-        
-        result = await client.call_tool("greet", {"name": "World"})
-        assert "Hello" in result.data
-​
-Testing Authentication
-The FastMCP Client handles authentication transparently, making it easy to test secured servers:
-
-Copy
-async def test_authenticated_server():
-    # Bearer token authentication
-    async with Client(
-        "https://api.example.com/mcp",
-        headers={"Authorization": "Bearer test-token"}
-    ) as client:
-        await client.ping()
-        tools = await client.list_tools()
-        
-    # OAuth flow (opens browser for authorization)
-    async with Client("https://api.example.com/mcp", auth="oauth") as client:
-        result = await client.call_tool("protected_tool", {})
-        assert result.data is not None
-​
-Best Practices
-Default to in-memory testing - It’s faster, more reliable, and easier to debug
-Test behavior, not implementation - Call tools and verify responses rather than testing internals
-Use framework fixtures - Create reusable server configurations for your test suite
-Mock external dependencies - Keep tests fast and deterministic by mocking databases, APIs, etc.
-Test error cases - Verify your server handles invalid inputs and edge cases properly
-The FastMCP Client transforms MCP server testing from a deployment challenge into a straightforward unit testing task. With in-memory connections and deterministic control, you can build comprehensive test suites that run in milliseconds.
-Project Configuration
-
-<!-- EOF -->