Connecting MCP Servers

MCP Servers allow Karyam to securely connect AI systems with external tools, services, and business applications.

Once connected, Karyam automatically discovers the capabilities exposed by the server and makes them available to Agents and AI Flows.

---

Before You Begin

Before connecting an MCP Server, ensure you have:

• An accessible MCP Server endpoint
• Required authentication credentials (if applicable)
• Network connectivity between Karyam and the MCP Server

---

Step 1 — Navigate to MCP Servers

Open:

MCP Servers

Click:

New MCP Server

---

Step 2 — Configure General Information

Provide basic information about the server.

Name

A friendly name used throughout Karyam.

Example:

GitHub MCP

---

Description

Optional information describing the server’s purpose.

Example:

GitHub repository automation and development workflows.

---

Step 3 — Configure Authentication

Karyam supports multiple authentication mechanisms.

None

Use when the MCP Server does not require authentication.

Example:

• Local development servers
• Internal trusted environments

---

OAuth 2.0

Use OAuth when connecting to secured services.

Supported modes include:

Automatic Discovery

Karyam automatically discovers OAuth configuration from the provider.

Recommended for:

• Standard OAuth providers
• Public cloud services
• SaaS platforms

---

Manual Discovery

Allows explicit OAuth endpoint configuration.

Recommended for:

• Internal identity providers
• Custom OAuth implementations
• Enterprise environments

---

Step 4 — Configure Server URL

Specify the MCP endpoint URL.

Example:

https://api.example.com/mcp/github

Examples:

https://mcp.company.internal/github
https://mcp.company.internal/jira
https://mcp.company.internal/hr

---

Step 5 — Configure Request Headers

Additional request headers can be attached to every request.

Examples include:

• API Keys
• Bearer Tokens
• Tenant Identifiers
• Custom Authentication Headers

Example:

Key	Value
Authorization	Bearer ****
X-Tenant-ID	company-prod

---

Encrypted Headers

Sensitive values can be encrypted before storage.

Encrypted values are:

• Securely stored
• Permanently masked after submission
• Never exposed in the user interface

Existing encrypted values cannot be viewed or recovered.

To update an encrypted value, a new value must be entered and saved again.

This helps organizations safely manage credentials and secrets.

---

Step 6 — Save The Server

Once configuration is complete, click:

Save

Karyam validates the configuration and registers the MCP Server.

---

Server Management

Each connected server contains two sections:

Settings

Manage:

• Name
• Description
• Authentication
• Headers
• Endpoint URL

---

Tools

The Tools section displays capabilities discovered from the MCP Server.

Click:

Sync Tools

Karyam will:

• Connect to the server
• Discover available tools
• Import tool definitions
• Update existing capabilities

---

Automatic Tool Discovery

Example:

GitHub MCP Server
        ↓
Sync Tools
        ↓
Discovered:
- Create Issue
- Create Pull Request
- Search Repository
- List Workflow Runs
- Get Repository Information

No manual schema configuration is required.

---

Tool Metadata

Each discovered tool can be expanded to view its metadata.

Metadata typically includes:

• Tool name
• Description
• Input schema
• Parameters
• Required fields
• Output schema

Example:

Create Issue
├── title
├── body
├── repository
└── labels

This allows users to understand exactly how the tool behaves before attaching it to Agents or AI Flows.

---

Attaching MCP Tools

Discovered tools can be attached directly to:

• Agents
• AI Flows

Example:

Agent Settings
    ↓
Attach MCP Tools
    ↓
Select:
- Create Issue
- Search Repository
- List Pull Requests

---

Example Workflow

Employee:
Create a GitHub issue for the VPN renewal problem.

Agent
    ↓
GitHub MCP Tool
    ↓
Create Issue
    ↓
Issue Created

---

Security Best Practices

When connecting MCP Servers:

• Use OAuth whenever possible.
• Encrypt sensitive headers.
• Use least-privilege credentials.
• Rotate credentials regularly.
• Restrict network access to trusted systems.

---

Troubleshooting

Connection Failed

Verify:

• Server URL
• Network connectivity
• Firewall rules
• DNS resolution

---

Authentication Failed

Verify:

• OAuth configuration
• Access tokens
• Header values
• Credential permissions

---

No Tools Found

Verify:

• The MCP Server is running.
• The endpoint is accessible.
• The authenticated user has permission to discover tools.

---

Next Steps

Continue with:

➡️ Authentication

Learn how Karyam securely manages OAuth flows, credentials, and encrypted headers for MCP Servers.

---