de en es ja ko ru zh

GoMCP

Name: GoMCP
Author: zhangpanda

by zhangpanda

Overview Schema Source Related Servers Discussions Admin

Hybrid

GoMCP

Go Version License Release gomcp MCP server

Быстрый и идиоматичный способ создания MCP-серверов на Go.

中文文档

🚀 Быстрые ссылки

GitHub: https://github.com/zhangpanda/gomcp
Gitee: https://gitee.com/rilegouasas/gomcp
Протокол MCP: https://modelcontextprotocol.io

Related MCP server: Filesystem MCP Server

🎯 Что такое GoMCP?

GoMCP — это фреймворк для создания серверов Model Context Protocol (MCP), а не просто SDK. Думайте о нем как о «Gin для MCP».

MCP — это открытый протокол, который позволяет ИИ-приложениям (Claude Desktop, Cursor, Kiro, VS Code Copilot) вызывать внешние инструменты, читать источники данных и использовать шаблоны промптов. GoMCP делает создание таких серверов тривиальной задачей.

Почему GoMCP?

	mcp-go (mark3labs)	Официальный Go SDK	GoMCP
Уровень	SDK	SDK	Фреймворк
Генерация схемы	Вручную	тег `jsonschema`	тег `mcp` + автовалидация
Middleware	Базовые хуки	Нет	Полная цепочка (Logger, Auth, RateLimit, OTel…)
Группы инструментов	Нет	Нет	Да (`user.get`, `admin.delete`)
Импорт маршрутов Gin	Нет	Нет	✅ Одна строка
Импорт OpenAPI/Swagger	Нет	Нет	✅ Одна строка
Импорт gRPC сервисов	Нет	Нет	✅
Встроенная аутентификация	Нет	Нет	Bearer, API Key, Basic + RBAC
Inspector UI	Нет	Нет	✅
Утилиты для тестирования	Базовые	Нет	пакет mcptest

🛠️ Технологический стек

Системные требования

Требование	Версия
Go	≥ 1.25
Протокол MCP	2024-11-05 (обратная совместимость с 2025-11-25)

Основные зависимости

Технология	Описание
Стандартная библиотека Go	Ядро фреймворка — ноль внешних зависимостей
Gin	Только адаптер — импорт существующих маршрутов Gin
gRPC	Только адаптер — импорт gRPC сервисов
OpenTelemetry	Опционально — распределенная трассировка
YAML v3	Только провайдер — горячая перезагрузка определений инструментов

🌟 Основные возможности

🔧 Разработка инструментов

Автоматическая генерация схемы через теги структур — определяйте параметры с помощью структур Go и тегов mcp, JSON Schema генерируется автоматически
Типизированные обработчики — func(*Context, Input) (Output, error) — никакой ручной обработки параметров
Валидация параметров — required, min/max, enum, pattern — проверяется до запуска вашего обработчика
Версионирование компонентов — регистрируйте несколько версий, клиенты вызывают name@version
Асинхронные задачи — долго выполняющиеся инструменты возвращают ID задачи с возможностью опроса и отмены

🔌 Адаптеры (Ключевое отличие)

Адаптер Gin — импорт существующих маршрутов Gin как инструментов MCP одной строкой
Адаптер OpenAPI — генерация инструментов из документации Swagger/OpenAPI 3.x
Адаптер gRPC — импорт методов gRPC сервисов как инструментов MCP

🔐 Безопасность

BearerAuth — валидация JWT токенов
APIKeyAuth — валидация API ключа через заголовок
BasicAuth — HTTP Basic аутентификация
RequireRole / RequirePermission — RBAC авторизация для групп инструментов

🧩 Возможности фреймворка

Цепочка middleware — Logger, Recovery, RequestID, Timeout, RateLimit, OpenTelemetry
Группы инструментов — организация инструментов с префиксами и middleware на уровне группы
Ресурсы и промпты — полная поддержка MCP, включая URI-шаблоны и параметризованные промпты
Автодополнение — подсказки значений для аргументов промптов/ресурсов

🚀 Готовность к продакшену

Множественные транспорты — stdio (Claude Desktop, Cursor, Kiro) и Streamable HTTP с SSE
MCP Inspector — встроенный веб-интерфейс для отладки, просмотра и тестирования инструментов
Горячая перезагрузка — загрузка определений инструментов из YAML-файлов с отслеживанием изменений
Пакет mcptest — in-memory клиент для модульного тестирования с поддержкой снимков (snapshots)

🏗️ Архитектура

┌──────────────────────────────────────────────────────────────┐
│                        User Code                             │
│   s.Tool() / s.ToolFunc() / s.Resource() / s.Prompt()        │
├──────────────────────────────────────────────────────────────┤
│                     Framework Core                           │
│   Router → Middleware Chain → Validation → Handler → Result   │
├────────────┬─────────────┬───────────────┬───────────────────┤
│   Schema   │  Validator  │   Adapters    │  Observability    │
│  Generator │   Engine    │ Gin/OpenAPI/  │  OTel / Logger    │
│ (mcp tags) │ (auto)      │ gRPC          │  / Inspector      │
├────────────┴─────────────┴───────────────┴───────────────────┤
│                     Protocol Layer                           │
│          JSON-RPC 2.0 / MCP / Capability Negotiation         │
├──────────────────────────────────────────────────────────────┤
│                     Transport Layer                          │
│              stdio  /  Streamable HTTP + SSE                 │
└──────────────────────────────────────────────────────────────┘

Структура проекта

gomcp/
├── server.go              # Server core, tool/resource/prompt registration
├── context.go             # Request context with typed accessors
├── group.go               # Tool groups with prefix naming
├── middleware.go           # Middleware interface and chain execution
├── middleware_builtin.go   # Logger, Recovery, RequestID, Timeout, RateLimit
├── middleware_auth.go      # BearerAuth, APIKeyAuth, BasicAuth, RBAC
├── middleware_otel.go      # OpenTelemetry tracing
├── schema/                # struct tag → JSON Schema generator + validator
├── transport/             # stdio + Streamable HTTP
├── adapter/               # Gin, OpenAPI, gRPC adapters
├── mcptest/               # Testing utilities
├── task.go                # Async task support
├── completion.go          # Auto-completions
├── inspector.go           # Web debug UI
├── provider.go            # Hot-reload from YAML
└── examples/              # Working examples

📦 Установка

go get github.com/zhangpanda/gomcp

⚡ Быстрый старт

5 строк до рабочего MCP-сервера

package main

import (
    "fmt"
    "github.com/zhangpanda/gomcp"
)

type SearchInput struct {
    Query string `json:"query" mcp:"required,desc=Search keyword"`
    Limit int    `json:"limit" mcp:"default=10,min=1,max=100"`
}

type SearchResult struct {
    Items []string `json:"items"`
    Total int      `json:"total"`
}

func main() {
    s := gomcp.New("my-server", "1.0.0")

    s.ToolFunc("search", "Search documents by keyword", func(ctx *gomcp.Context, in SearchInput) (SearchResult, error) {
        items := []string{fmt.Sprintf("Result for %q", in.Query)}
        return SearchResult{Items: items, Total: len(items)}, nil
    })

    s.Stdio()
}

Структура SearchInput автоматически генерирует эту JSON Schema:

{
  "type": "object",
  "properties": {
    "query": { "type": "string", "description": "Search keyword" },
    "limit": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }
  },
  "required": ["query"]
}

Некорректные параметры отклоняются до запуска вашего обработчика:

validation failed: query: required; limit: must be <= 100

📖 Руководство по использованию

Справочник тегов структур

Тег	Тип	Описание	Пример
`required`	флаг	Поле обязательно для заполнения	`mcp:"required"`
`desc`	строка	Человекочитаемое описание	`mcp:"desc=Поисковый запрос"`
`default`	любой	Значение по умолчанию	`mcp:"default=10"`
`min`	число	Минимальное значение (включительно)	`mcp:"min=0"`
`max`	число	Максимальное значение (включительно)	`mcp:"max=100"`
`enum`	строка	Допустимые значения через пайп	`mcp:"enum=asc	desc"`
`pattern`	строка	Валидация через регулярное выражение	`mcp:"pattern=^[a-z]+$"`

Комбинирование: mcp:"required,desc=Email пользователя,pattern=^[^@]+@[^@]+$"

Поддерживаемые типы: string, int, float64, bool, []T, вложенные структуры.

Инструменты

Простой обработчик:

s.Tool("hello", "Say hello", func(ctx *gomcp.Context) (*gomcp.CallToolResult, error) {
    return ctx.Text("Hello, " + ctx.String("name")), nil
})

Типизированный обработчик (рекомендуется):

type Input struct {
    Name  string `json:"name"  mcp:"required,desc=User name"`
    Email string `json:"email" mcp:"required,pattern=^[^@]+@[^@]+$"`
}

s.ToolFunc("create_user", "Create user", func(ctx *gomcp.Context, in Input) (User, error) {
    return db.CreateUser(in.Name, in.Email)
})

Ресурсы

// Static
s.Resource("config://app", "App config", func(ctx *gomcp.Context) (any, error) {
    return map[string]any{"version": "1.0"}, nil
})

// Dynamic URI template
s.ResourceTemplate("db://{table}/{id}", "DB record", func(ctx *gomcp.Context) (any, error) {
    return db.Find(ctx.String("table"), ctx.String("id")), nil
})

Промпты

s.Prompt("code_review", "Code review",
    []gomcp.PromptArgument{gomcp.PromptArg("language", "Language", true)},
    func(ctx *gomcp.Context) ([]gomcp.PromptMessage, error) {
        return []gomcp.PromptMessage{
            gomcp.UserMsg(fmt.Sprintf("Review this %s code for bugs.", ctx.String("language"))),
        }, nil
    },
)

Middleware

s.Use(gomcp.Logger())                              // Log tool name + duration
s.Use(gomcp.Recovery())                            // Recover from panics
s.Use(gomcp.RequestID())                           // Unique request ID
s.Use(gomcp.Timeout(10 * time.Second))             // Deadline enforcement
s.Use(gomcp.RateLimit(100))                        // 100 calls/minute
s.Use(gomcp.OpenTelemetry())                       // Distributed tracing
s.Use(gomcp.BearerAuth(tokenValidator))            // JWT auth
s.Use(gomcp.APIKeyAuth("X-API-Key", keyValidator)) // API key auth

Пользовательское middleware:

func AuditLog() gomcp.Middleware {
    return func(ctx *gomcp.Context, next func() error) error {
        start := time.Now()
        err := next()
        log.Printf("tool=%s duration=%s err=%v", ctx.String("_tool_name"), time.Since(start), err)
        return err
    }
}

Группы инструментов

user := s.Group("user", authMiddleware)
user.Tool("get", "Get user", getUser)              // → user.get
user.Tool("update", "Update user", updateUser)      // → user.update

admin := user.Group("admin", gomcp.RequireRole("admin"))
admin.Tool("delete", "Delete user", deleteUser)     // → user.admin.delete

Адаптеры

Gin — одна строка для импорта вашего существующего API:

adapter.ImportGin(s, ginRouter, adapter.ImportOptions{
    IncludePaths: []string{"/api/v1/"},
})
// GET /api/v1/users/:id → Tool get_api_v1_users_by_id (id = required param)

OpenAPI — генерация из Swagger-документации:

adapter.ImportOpenAPI(s, "./swagger.yaml", adapter.OpenAPIOptions{
    TagFilter: []string{"pets"},
    ServerURL: "https://api.example.com",
})

gRPC:

adapter.ImportGRPC(s, grpcConn, adapter.GRPCOptions{
    Services: []string{"user.UserService"},
})

Версионирование компонентов

s.ToolFunc("search", "v1", searchV1, gomcp.Version("1.0"))
s.ToolFunc("search", "v2 with embeddings", searchV2, gomcp.Version("2.0"))
// "search" → latest, "search@1.0" → exact version

Асинхронные задачи

s.AsyncTool("report", "Generate report", func(ctx *gomcp.Context) (*gomcp.CallToolResult, error) {
    // long-running work
    return ctx.Text("done"), nil
})
// Client gets taskId immediately, polls tasks/get, can tasks/cancel

Горячая перезагрузка

s.LoadDir("./tools/", gomcp.DirOptions{Watch: true})

MCP Inspector

s.Dev(":9090") // http://localhost:9090 — browse and test all tools

Тестирование

func TestSearch(t *testing.T) {
    c := mcptest.NewClient(t, setupServer())
    c.Initialize()

    result := c.CallTool("search", map[string]any{"query": "golang"})
    result.AssertNoError(t)
    result.AssertContains(t, "golang")

    mcptest.MatchSnapshot(t, "search_result", result)
}

Транспорты

s.Stdio()          // Claude Desktop, Cursor, Kiro
s.HTTP(":8080")    // Remote deployment with SSE
s.Handler()        // Embed in existing HTTP server

Использование с ИИ-клиентами

{
  "mcpServers": {
    "my-server": {
      "command": "/path/to/your/binary"
    }
  }
}

Работает с Claude Desktop, Cursor, Kiro, Windsurf, VS Code Copilot и любым клиентом, совместимым с MCP.

📋 Дорожная карта

[x] Ядро: Инструменты, Ресурсы, Промпты с полной поддержкой протокола MCP
[x] Автоматическая генерация схемы через теги структур + валидация параметров
[x] Цепочка middleware (Logger, Recovery, RateLimit, Timeout, RequestID)
[x] Middleware аутентификации (Bearer / API Key / Basic) + RBAC авторизация
[x] Группы инструментов с префиксами и вложенными группами
[x] Транспорты stdio + Streamable HTTP с уведомлениями SSE
[x] Адаптер Gin — импорт существующих маршрутов Gin как инструментов MCP
[x] Адаптер OpenAPI — генерация инструментов из документации Swagger/OpenAPI
[x] Адаптер gRPC — импорт gRPC сервисов как инструментов MCP
[x] Интеграция OpenTelemetry
[x] Пакет mcptest с тестированием через снимки (snapshots)
[x] Версионирование компонентов + устаревание (deprecation)
[x] Асинхронные задачи с опросом и отменой
[x] Веб-интерфейс отладки MCP Inspector
[x] Провайдер горячей перезагрузки из YAML
[x] Автодополнение для аргументов промптов/ресурсов

🤝 Обратная связь и поддержка

Сообщения об ошибках: GitHub Issues
Запросы функций: GitHub Issues
Обсуждения: GitHub Discussions

💡 Рекомендуемое чтение: Как задавать вопросы правильно

🔒 Безопасность

Чтобы сообщить об уязвимостях безопасности, см. SECURITY.md.

⚖️ Авторские права и лицензия

Лицензировано под Apache License 2.0.

Важные примечания

Этот проект является открытым и бесплатным как для личного, так и для коммерческого использования под лицензией Apache 2.0.
Вы обязаны сохранить уведомление об авторских правах, текст лицензии и любые уведомления об авторстве во всех копиях или существенных частях программного обеспечения.
Лицензия Apache 2.0 включает прямое предоставление патентных прав от участников пользователям.
Вклады в этот проект лицензируются на условиях той же лицензии Apache 2.0.
Несанкционированное удаление уведомлений об авторских правах может привести к судебному преследованию.

Патентное уведомление

Некоторые функции этого фреймворка (генерация схемы через теги структур, автоматический адаптер HTTP-to-MCP, автоматический адаптер OpenAPI-to-MCP) являются предметом поданных патентных заявок. Лицензия Apache 2.0 предоставляет вам бессрочную, всемирную, безвозмездную патентную лицензию на использование этих функций как части данного программного обеспечения.

⭐ История звезд

Если вы находите GoMCP полезным, пожалуйста, поставьте звезду! Это помогает другим узнать о проекте.

Available Tools

5 tools

generate_reportC

Generate an analytics report for a given topic. This is a long-running operation that executes asynchronously and may take several minutes. Returns a task ID immediately; poll tasks/get for the result, or call tasks/cancel to abort. Use this for comprehensive data analysis tasks. Demo: short simulated delay (~2s), not multi-minute workload. No persistence of reports in this sample; cancel via tasks/cancel stops the tracked task.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

TDQS

C2.9/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Even without annotations, the description clearly discloses async behavior, immediate task ID return, no persistence, cancellation options, and demo simulation details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences covering purpose, async nature, and demo caveat. Efficient but could be slightly more concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers async behavior and task management, but fails to explain what data the report uses (topic parameter missing) and does not describe return value shape or error scenarios.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description mentions a 'given topic' but the schema has no parameters. This misalignment reduces the added value; with 100% schema coverage (zero parameters), the description should not imply nonexistent parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Generate an analytics report for a given topic' but the input schema has no parameters, making it unclear how to specify the topic. This contradiction reduces clarity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description indicates this is a long-running async operation and mentions polling and cancellation. However, it does not explicitly compare to sibling tools or specify when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_configA

Retrieve the current server configuration including version, environment, and feature flags. Use this to inspect server state or verify deployment settings. This is a read-only operation with no side effects. Demo: static JSON only; does not expose real secrets or live infrastructure. Subject to rate limit and timeout; no authentication in this binary.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

TDQS

A4.7/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, description fully discloses read-only nature, no side effects, rate limit, timeout, lack of authentication, and demo limitation (static JSON, no real secrets).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four sentences, each essential: purpose, usage, read-only statement, and constraints. Front-loaded and efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters and no output schema, description covers purpose, use cases, behavior, and constraints fully, leaving no ambiguity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Zero parameters with 100% schema coverage, baseline 4 per guidelines. No additional parameter info needed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states 'Retrieve the current server configuration including version, environment, and feature flags' with specific verb and resource. Differentiates from siblings like generate_report, greet_user, search_documents, and search_semantic.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit use cases: 'inspect server state or verify deployment settings.' Does not explicitly mention when not to use or name alternatives, but context implies appropriate usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

greet_userA

Greet a user by name. Returns a personalized greeting message. If no name is provided, defaults to 'World'. Use this tool to verify server connectivity or welcome a user. Demo server: no authentication; requests are subject to global rate limiting (600 calls/minute) and request timeout (30s). Read-only greeting text output; no writes or external side effects.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

TDQS

A3.6/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden. It discloses that the tool is read-only, has no side effects, and is subject to rate limiting (600 calls/minute) and timeout (30s). However, it contradicts the input schema by mentioning a 'name' parameter that does not exist, which undermines reliability.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three concise sentences, front-loading the main purpose and usage. Every sentence adds relevant information without redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with zero parameters and no output schema, the description covers purpose, usage, safety, and constraints. However, the misleading claim about a 'name' parameter reduces completeness and trustworthiness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has zero parameters, but the description claims a 'name' parameter defaults to 'World'. This is misleading and adds no value beyond the schema; it introduces confusion about the tool's actual interface.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool greets a user by name and returns a personalized greeting, which is a specific verb-resource combination. It also mentions verifying server connectivity and welcoming, further clarifying the purpose. The sibling tools (generate_report, get_config, etc.) are unrelated, so differentiation is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states 'Use this tool to verify server connectivity or welcome a user,' providing clear context for when to use it. It also mentions demo server constraints, but does not explicitly state when not to use it or offer alternatives, though the sibling tools are clearly different.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_documentsA

Search documents by keyword using full-text matching. Returns matching documents ranked by relevance with titles and content snippets. Use this when you need to find documents containing specific words or phrases. For semantic meaning-based search, use search_semantic instead. Demo: mock in-memory results only (no real document store). No auth in this sample; rate limit and timeout apply. On failure, returns an error or empty result set—no destructive operations.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of results to return. Use smaller values for quick lookups and larger values for comprehensive searches.
`query`	Yes	The search query string. Supports keywords and phrases to match against document titles and content.

TDQS

A4.6/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses mock nature, no auth, rate limits, timeout, and non-destructive behavior despite no annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Concise but informative; key information front-loaded; no redundant sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Explains return values (ranked results with snippets) and failure modes; sufficient for tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers 100% parameter semantics; description adds no extra detail beyond schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states 'Search documents by keyword using full-text matching' with specific verb and resource. Distinguishes from sibling 'search_semantic'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'Use this when you need to find documents containing specific words or phrases' and directs to alternative for semantic search.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_semanticA

Search documents using semantic embedding-based matching. Returns results ranked by meaning similarity rather than exact keyword match. Use this when the user's intent matters more than exact wording. For exact keyword matching, use search_documents instead. Demo: simplified mock (no real embeddings API); no auth; same rate limit/timeout as other tools. Read-only; does not modify documents.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of results to return. Use smaller values for quick lookups and larger values for comprehensive searches.
`query`	Yes	The search query string. Supports keywords and phrases to match against document titles and content.

TDQS

A4.8/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, but the description fully covers behavioral traits: read-only, mock embeddings (demo), no auth, same rate limit/timeout, and does not modify documents.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured and concise. First sentence states core purpose, then usage guidance, then demo caveats. Every sentence adds value with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, usage, behavioral aspects, and schema. However, without an output schema, the description does not explain return values or result format, which could be helpful for a search tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers both parameters with descriptions (100% coverage). The description adds value by explaining the semantic nature, but does not add new parameter-level details beyond schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states semantic embedding-based matching, ranking by meaning similarity, and explicitly distinguishes from exact keyword search, naming the sibling tool search_documents.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says when to use (user intent matters more than exact wording) and when not (use search_documents instead). Also includes demo context and limitations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

10 tool updatesv0.1.3Apr 17, 2026
- Addedgenerate_report
- Addedget_config
- Addedgreet_user
- Removedhello
- Removedreport
- Addedsearch_documents
- Addedsearch_semantic
- Removedsearch.docs
- Removedsearch@1.0
- Removedsearch@2.0

3 tool updatesv0.1.2Apr 17, 2026

Changedsearch.docs2 fields changed

addedInput schema / properties / limit / description

Added value: +"Maximum number of results to return. Use smaller values for quick lookups and larger values for comprehensive searches."

changedInput schema / properties / query / description

Previous value: -"Search keyword"New value: +"The search query string. Supports keywords and phrases to match against document titles and content."

Changedsearch@1.02 fields changed

addedInput schema / properties / limit / description

Added value: +"Maximum number of results to return. Use smaller values for quick lookups and larger values for comprehensive searches."

changedInput schema / properties / query / description

Previous value: -"Search keyword"New value: +"The search query string. Supports keywords and phrases to match against document titles and content."

Changedsearch@2.02 fields changed

addedInput schema / properties / limit / description

Added value: +"Maximum number of results to return. Use smaller values for quick lookups and larger values for comprehensive searches."

changedInput schema / properties / query / description

Previous value: -"Search keyword"New value: +"The search query string. Supports keywords and phrases to match against document titles and content."

5 tool updatesv0.1.0Apr 17, 2026
- First observedhello
- First observedreport
- First observedsearch.docs
- First observedsearch@1.0
- First observedsearch@2.0

Deploy Server

RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

TDQS

A3.8/5.0

Scored 2026-05-13 05:40 across 5 tools

Disambiguation5/5

Each tool has a clearly distinct purpose: report generation, config retrieval, greeting, keyword search, and semantic search. The two search tools explicitly differentiate themselves via descriptions and cross-references, eliminating ambiguity.

Naming Consistency5/5

All tools use a consistent verb_noun pattern in snake_case (generate_report, get_config, greet_user, search_documents, search_semantic). The naming is predictable and uniform.

Tool Count5/5

With 5 tools, the server is well-scoped for a lightweight demo/utility server. Each tool serves a distinct function without unnecessary bloat, fitting its apparent purpose.

Completeness2/5

The tool set is a mix of unrelated utilities with notable gaps: generate_report mentions async tasks and task management endpoints (tasks/get, tasks/cancel) but those are not provided as tools. There is no CRUD coverage or coherent domain lifecycle, making the surface incomplete.

Maintenance

ActivitySlowing

ResponsivenessResponsive

Resources

GitHub Repository

Need Help?

Related Servers

Related MCP Connectors

Apideck MCP A
dev.apideck.mcp
Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server
Developer Tools
42
ArcjetOAuth
com.arcjet
An MCP server for Arcjet - the runtime security platform that ships with your AI code.
Security AI & Machine Learning Code Execution
21
typeshipOAuth
dev.typeship
Generate a typed SDK, CLI, and MCP server from any OpenAPI or GraphQL spec, and keep them current.
Developer Tools CI/CD & DevOps
1
mcp AOAuth
com.mux
The official MCP Server for the Mux API
Multimedia Processing Entertainment & Media API Testing
22168

Related MCP Servers

mcp-k8s-go
Cloud Platforms Developer Tools Virtualization
strowk
A
license
Not graded
quality
D
maintenance
This project is intended as a both MCP server connecting to Kubernetes and a library to build more servers for any custom resources in Kubernetes.
Updated 9 months ago (2025-12-22 20:12 UTC)
384
MIT
Filesystem MCP Server
File Systems OS Automation
mark3labs
A
license
Not graded
quality
F
maintenance
Go server implementing Model Context Protocol (MCP) for filesystem operations.
Updated 10 months ago (2025-11-24 15:46 UTC)
685
MIT
go-mcp-postgres
Databases Developer Tools Code Execution
guoling2008
A
license
Not graded
quality
D
maintenance
what is go-mcp-postgres? go-mcp-postgres is a Model Context Protocol (MCP) server designed for interacting with Postgres databases, allowing for easy CRUD operations and automation without the need for a Node.js or Python environment.
Updated a year ago (2025-08-27 02:09 UTC)
7
MIT
MCP Hello World
Developer Tools Code Execution
MillCityAI
F
license
B
quality
Not graded
maintenance
A minimal reference implementation of an MCP server that responds with "Hello, World" via Streamable HTTP. Serves as a baseline for integration testing and MCP client development with production-ready features including health checks, metrics, and containerized deployment.
Updated a year ago (2025-08-29 19:08 UTC)
3
18,765
-